From: James Westby <jw+debian@jameswestby.net>
To: linux-sparse@vger.kernel.org
Subject: [PATCH] Update the information in README about using the library.
Date: Mon, 18 Dec 2006 22:00:21 +0000 [thread overview]
Message-ID: <20061218220021.GC8251@jameswestby.net> (raw)
Changes in the library have left the README giving out of date information
on how to intialise the library and get the symbols out of it. Update the
documentation to match the latest functions.
Signed-off-by: James Westby <jw+debian@jameswestby.net>
---
README | 29 ++++++++---------------------
1 files changed, 8 insertions(+), 21 deletions(-)
diff --git a/README b/README
index 6b1034b..69492ab 100644
--- a/README
+++ b/README
@@ -47,35 +47,22 @@ requires the information.
This means that a user of the library will literally just need to do
- struct token *token;
- int fd = open(filename, O_RDONLY);
- struct symbol_list *list = NULL;
+ struct string_list *filelist = NULL;
+ char *file;
- if (fd < 0)
- exit_with_complaint();
+ action(sparse_initialize(argc, argv, filelist));
- // Initialize parse symbols
- init_symbols();
-
- // Tokenize the input stream
- token = tokenize(filename, fd, NULL);
-
- // Pre-process the stream
- token = preprocess(token);
-
- // Parse the resulting C code
- translation_unit(token, &list);
-
- // Evaluate the types now if we want to
- // Or leave it until later.
- symbol_iterate(list, evaluate_symbol, NULL);
+ FOR_EACH_PTR_NOTAG(filelist, file) {
+ action(sparse(file));
+ } END_FOR_EACH_PTR_NOTAG(file);
and he is now done - having a full C parse of the file he opened. The
library doesn't need any more setup, and once done does not impose any
more requirements. The user is free to do whatever he wants with the
parse tree that got built up, and needs not worry about the library ever
again. There is no extra state, there are no parser callbacks, there is
-only the parse tree that is described by the header files.
+only the parse tree that is described by the header files. The action
+funtion takes a pointer to a symbol_list and does whatever it likes with it.
The library also contains (as an example user) a few clients that do the
preprocessing, parsing and type evaluation and just print out the
--
1.4.4.2
next reply other threads:[~2006-12-18 22:00 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2006-12-18 22:00 James Westby [this message]
2007-02-27 19:05 ` [PATCH] Update the information in README about using the library Josh Triplett
-- strict thread matches above, loose matches on Subject: below --
2013-12-03 8:26 Franz Schrober
2013-12-03 23:17 ` Christopher Li
2013-12-03 23:45 ` Josh Triplett
2013-12-04 0:12 ` Christopher Li
2013-12-09 9:21 ` Christopher Li
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20061218220021.GC8251@jameswestby.net \
--to=jw+debian@jameswestby.net \
--cc=linux-sparse@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).