summaryrefslogtreecommitdiffabout
path: root/include/sitecing
authorMichael Krelin <hacker@klever.net>2007-03-04 00:51:48 (UTC)
committer Michael Krelin <hacker@klever.net>2007-03-04 00:51:48 (UTC)
commit8677376c6669ad29bf24e237f626fd8296558f9b (patch) (unidiff)
tree1690b574355458356ea87a66387db1758c2ac9b1 /include/sitecing
parenta3f38aafb288db5791b8dea34154cacc3c039971 (diff)
downloadsitecing-8677376c6669ad29bf24e237f626fd8296558f9b.zip
sitecing-8677376c6669ad29bf24e237f626fd8296558f9b.tar.gz
sitecing-8677376c6669ad29bf24e237f626fd8296558f9b.tar.bz2
doxygen update
Diffstat (limited to 'include/sitecing') (more/less context) (ignore whitespace changes)
-rw-r--r--include/sitecing/sitecing_enflesher.h18
-rw-r--r--include/sitecing/sitecing_parser.h16
2 files changed, 29 insertions, 5 deletions
diff --git a/include/sitecing/sitecing_enflesher.h b/include/sitecing/sitecing_enflesher.h
index db15bc3..9eefdcc 100644
--- a/include/sitecing/sitecing_enflesher.h
+++ b/include/sitecing/sitecing_enflesher.h
@@ -1,88 +1,100 @@
1#ifndef __SITECING_SITECING_ENFLESHER_H 1#ifndef __SITECING_SITECING_ENFLESHER_H
2#define __SITECING_SITECING_ENFLESHER_H 2#define __SITECING_SITECING_ENFLESHER_H
3 3
4#include <fstream> 4#include <fstream>
5#include <string> 5#include <string>
6using namespace std; 6using namespace std;
7 7
8/** 8/**
9 * @file 9 * @file
10 * @brief The preprocessed source builder. 10 * @brief The preprocessed source builder.
11 */ 11 */
12 12
13#ifndef sitecing_enflesher_flexlexer_once 13#ifndef sitecing_enflesher_flexlexer_once
14#define sitecing_enflesher_flexlexer_once 14#define sitecing_enflesher_flexlexer_once
15#undef yyFlexLexer 15#undef yyFlexLexer
16/**
17 * nevermind me
18 */
16#define yyFlexLexer sitecing_enflesherFlexLexer 19#define yyFlexLexer sitecing_enflesherFlexLexer
17#include <FlexLexer.h> 20#include <FlexLexer.h>
18#undef yyFlexLexerOnce 21#undef yyFlexLexerOnce
19#endif 22#endif
20 23
21class sitecing_parser; 24class sitecing_parser;
22/** 25/**
23 * The enfleshing of the skeleton file according to the in-memory parsed 26 * The enfleshing of the skeleton file according to the in-memory parsed
24 * component source. 27 * component source.
25 */ 28 */
26class sitecing_enflesher : public sitecing_enflesherFlexLexer { 29class sitecing_enflesher : public sitecing_enflesherFlexLexer {
27 public: 30 public:
28 /** 31 /**
29 * It is time to anchor output with the #line directive. 32 * It is time to anchor output with the \#line directive.
30 */ 33 */
31 bool anchor_time; 34 bool anchor_time;
32 /** 35 /**
33 * The file currently being written is supposed to have #line 36 * The file currently being written is supposed to have \#line
34 * directives all around the place. 37 * directives all around the place.
35 */ 38 */
36 bool anchoraged; 39 bool anchoraged;
37 /** 40 /**
38 * The reference to the parser object containg the parsed source. 41 * The reference to the parser object containg the parsed source.
39 */ 42 */
40 sitecing_parser& parser; 43 sitecing_parser& parser;
41 /** 44 /**
42 * The output stream. 45 * The output stream.
43 */ 46 */
44 ofstream outs; 47 ofstream outs;
45 /** 48 /**
46 * the outs stream destination file. 49 * the outs stream destination file.
47 * @see outs 50 * @see outs
48 */ 51 */
49 string outs_filename; 52 string outs_filename;
50 53
51 /** 54 /**
52 * @param p The parser object containing preparsed data. 55 * @param p The parser object containing preparsed data.
53 */ 56 */
54 sitecing_enflesher(sitecing_parser& p) 57 sitecing_enflesher(sitecing_parser& p)
55 : parser(p), anchor_time(true) { } 58 : parser(p), anchor_time(true) { }
56 59
57 /** 60 /**
58 * Do the job. 61 * Do the job.
59 */ 62 */
60 void enflesh(); 63 void enflesh();
61 64
65 /**
66 * Output parsed data
67 * @param buf pointer to the data
68 * @param size length of the buffer pointed by buf
69 */
62 virtual void LexerOutput(const char *buf,int size); 70 virtual void LexerOutput(const char *buf,int size);
71 /**
72 * Lexer generated by flex
73 * @return zero on success
74 */
63 virtual int yylex(); 75 virtual int yylex();
64 76
65 /** 77 /**
66 * Put a #line anchor into output. 78 * Put a \#line anchor into output.
67 */ 79 */
68 void anchor(); 80 void anchor();
69 81
70 /** 82 /**
71 * Close previously opened output stream, rename to the 'correct' 83 * Close previously opened output stream, rename to the 'correct'
72 * destination filename, if needed, and open new file. 84 * destination filename, if needed, and open new file.
73 * @see outs 85 * @see outs
74 * @see outs_filename 86 * @see outs_filename
75 * @see outs_close 87 * @see outs_close
76 */ 88 */
77 void outs_open(const string& nfile); 89 void outs_open(const string& nfile);
78 /** 90 /**
79 * Close previously opened output stream, and rename to the 'correct' 91 * Close previously opened output stream, and rename to the 'correct'
80 * destination filename, if needed. 92 * destination filename, if needed.
81 * @see outs_open 93 * @see outs_open
82 * @see outs 94 * @see outs
83 * @see outs_filename 95 * @see outs_filename
84 */ 96 */
85 void outs_close(); 97 void outs_close();
86}; 98};
87 99
88#endif /* __SITECING_SITECING_ENFLESHER_H */ 100#endif /* __SITECING_SITECING_ENFLESHER_H */
diff --git a/include/sitecing/sitecing_parser.h b/include/sitecing/sitecing_parser.h
index a53ef22..bcabc5c 100644
--- a/include/sitecing/sitecing_parser.h
+++ b/include/sitecing/sitecing_parser.h
@@ -1,44 +1,47 @@
1#ifndef __SITECING_SITECING_PARSER_H 1#ifndef __SITECING_SITECING_PARSER_H
2#define __SITECING_SITECING_PARSER_H 2#define __SITECING_SITECING_PARSER_H
3 3
4#include <string> 4#include <string>
5#include <list> 5#include <list>
6#include <map> 6#include <map>
7#include <stdexcept> 7#include <stdexcept>
8using namespace std; 8using namespace std;
9 9
10#include "sitecing/component_factory.h" 10#include "sitecing/component_factory.h"
11using namespace sitecing; 11using namespace sitecing;
12 12
13/** 13/**
14 * @file 14 * @file
15 * @brief The component source parser. 15 * @brief The component source parser.
16 */ 16 */
17 17
18#ifndef sitecing_parser_flexlexer_once 18#ifndef sitecing_parser_flexlexer_once
19#define sitecing_parser_flexlexer_once 19#define sitecing_parser_flexlexer_once
20#undef yyFlexLexer 20#undef yyFlexLexer
21/**
22 * nevermind me
23 */
21#define yyFlexLexer sitecing_parserFlexLexer 24#define yyFlexLexer sitecing_parserFlexLexer
22#include <FlexLexer.h> 25#include <FlexLexer.h>
23#undef yyFlexLexerOnce 26#undef yyFlexLexerOnce
24#endif 27#endif
25 28
26/** 29/**
27 * The component source parser. 30 * The component source parser.
28 */ 31 */
29class sitecing_parser : public sitecing_parserFlexLexer { 32class sitecing_parser : public sitecing_parserFlexLexer {
30 public: 33 public:
31 /** 34 /**
32 * The ancestor class definition. 35 * The ancestor class definition.
33 */ 36 */
34 class ancestor_class { 37 class ancestor_class {
35 public: 38 public:
36 /** 39 /**
37 * The class name. 40 * The class name.
38 */ 41 */
39 string name; 42 string name;
40 /** 43 /**
41 * The source component path. 44 * The source component path.
42 */ 45 */
43 string path; 46 string path;
44 47
@@ -290,45 +293,54 @@ class sitecing_parser : public sitecing_parserFlexLexer {
290 /** 293 /**
291 * The reference to the component factory object. 294 * The reference to the component factory object.
292 */ 295 */
293 component_factory& factory; 296 component_factory& factory;
294 /** 297 /**
295 * Pragma map type. 298 * Pragma map type.
296 */ 299 */
297 typedef map<string,string> pragmas_t; 300 typedef map<string,string> pragmas_t;
298 /** 301 /**
299 * Pragma's found in the component. 302 * Pragma's found in the component.
300 */ 303 */
301 pragmas_t pragmas; 304 pragmas_t pragmas;
302 305
303 /** 306 /**
304 * @param f the component factory. 307 * @param f the component factory.
305 */ 308 */
306 sitecing_parser(component_factory& f); 309 sitecing_parser(component_factory& f);
307 310
308 /** 311 /**
309 * Preprocess file. 312 * Preprocess file.
310 * @param in input file name. 313 * @param in input file name.
311 */ 314 */
312 void preprocess(const string& in); 315 void preprocess(const string& in);
313 316
317 /**
318 * Output parsed data
319 * @param buf pointer to the data
320 * @param size length of the buffer pointed by buf
321 */
314 virtual void LexerOutput(const char *buf,int size); 322 virtual void LexerOutput(const char *buf,int size);
323 /**
324 * Lexer generated by flex
325 * @return zero on success
326 */
315 virtual int yylex(); 327 virtual int yylex();
316 328
317 /** 329 /**
318 * Retrieve reference to the to of the modes stack. 330 * Retrieve reference to the to of the modes stack.
319 * @return the reference in question. 331 * @return the reference in question.
320 */ 332 */
321 modus_operandi& M() { 333 modus_operandi& M() {
322 return modi.front(); 334 return modi.front();
323 } 335 }
324 /** 336 /**
325 * Anchor the output with the #line, if we're not in the text output mode. 337 * Anchor the output with the \#line, if we're not in the text output mode.
326 */ 338 */
327 void soft_anchor(); 339 void soft_anchor();
328 /** 340 /**
329 * Anchor the output with the #line directive, changing to the appropriate output mode if needed. 341 * Anchor the output with the \#line directive, changing to the appropriate output mode if needed.
330 */ 342 */
331 void anchor(); 343 void anchor();
332}; 344};
333 345
334#endif /* __SITECING_SITECING_PARSER_H */ 346#endif /* __SITECING_SITECING_PARSER_H */