summaryrefslogtreecommitdiffstats
path: root/TODO
blob: 24d124445d90ec84949b358b958159c17b2b20c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
`mkid' TODO - Future directions

* Bring all code into conformance with GNU project coding standards.
  - Use command-line arguments, not the name of the program in argv[0]
    to determine lid's behavior
  - Revise the command-line argument syntax, in particular the mkid
    scanner-arg syntax.
  - Use getopt_long () in all programs to parse command-line arguments
  - Handle GNU standard arguments: In particular, --version & --help
  - use xmalloc

* Portability & uniformity
  - configure tests for lots of things, but code doesn't use all
    results.  Either use the results, or drop the tests.
  - Fix filenames.c to handle non-UNIX file names properly
    (notably DOS & OS/2).
  - Fix assumption that (sizeof (int) == sizeof (long))
  - use alloca
  - use xmalloc

* all query interfaces
  - add environment variable for setting default ID file name--allow this
    variable to be a "path" to handle multiple ID files, e.g.,
	IDFILE=/usr/src/ID:/usr/local/src/ID:$HOME/src/ID
    also allow dirs (considered to contain a file named "ID" by default)

* mkid & lid
  - store & retrieve floating point literals
  - automatically crack (optionally gzipped or compressed) tar files, so
    you can index and search archived source without having to unpack it.

* mkid
  - add a recursive file tree walker, so a complete list of file names
    need not be supplied--implement with ftw(3)?
  - (Optinally?) store tokenized contents of comments.
  - Store attributes with symbols: type, func, variable struct-tag
    enum-tag, keyword, etc.  Store caller/callee relationships between
    identifiers.  Indicate which files have defns vs. uses.  This info
    is needed to support a cscope interface.
  - Add times(2) results to statistics output.
  - treat \ specially for TeX files and do likewise with @ for Texinfo.
  - add time(1) style output to statistics report at end
  - control stats reports with a command-line arg.

* lid
  - change the name of the program to something a bit more
    descriptive, e.g., "findid".
  - use "long long" (if the compiler supports it) integer comparisons
    in find_number().
  - generalize the command-line interface for different behaviors.
    User passes a command-format string for operating on the results
    of a query:
    %t = token, %f = crunched file list, %F = uncrunched file list
    Recommend the following aliases to emulate old behavior:
      alias lid="findid -e 'echo %t %f'"
      alias eid="findid -e 'vi +/\\<%t\\>/ %F'" # for vi users
      alias gid="findid -e 'egrep \\<%t\\> %F'"
  - make `pid' a separate program
  - standardize & document regexp syntax (currently, it depends on whether
    you link rx.o or your vendor's regexp stuff).
  - gid bug: "gid -e file_" yeilds nothing.

* iid
  - don't use $PS1 for the prompt.  Use (iid), or iid> or something like that
  - review (revise?) syntax

* gid.el
  - associate ID file with buffers so future `gid's will use the right ID.
  - wire completion on token names

* cscope
  - add a cscope work-alike query interface (this is being done by
    Maureen Lecuona <lecuona@paul.rutgers.edu>)

* grep
  - Hack GNU grep to use a mkid database for hints about which files to
    search. 


Local Variables:
mode: text
fill-column: 75
End: