fbdoc  1.0.1
FreeBASIC documentation tool
fbdoc_options.bi
Go to the documentation of this file.
1 
9 
10 #INCLUDE ONCE "dir.bi"
11 #INCLUDE ONCE "fbdoc_parser.bi"
12 
13 CONST _
14  LFN_FILE = "fbdoc.lfn" _
15  , LFN_SEP = !"\n"
16 
17 
18 
19 #DEFINE ERROUT(_T_) PRINT #OPT->Efnr, PROJ_NAME & ": " & _T_
20 
21 
22 #DEFINE MSG_LINE(_T_) PRINT #OPT->Efnr, NL; SPC(38 - LEN(_T_)); _T_; " -->";
23 
24 
25 #DEFINE MSG_CONT(_T_) PRINT #OPT->Efnr, " " & _T_;
26 
27 
28 #DEFINE MSG_END(_T_) PRINT #OPT->Efnr, _T_
29 
30 
31 
39 TYPE Options
40 
41  ENUM RunModes
42 
43 
48 
49 
54 
55 
59 
60 
65 
66 
69  DEF_MODE
70 
71 
78  FILE_MODE
79 
80 
87  LIST_MODE
88 
89 
98  SYNT_MODE
99 
100  END ENUM
101 
102 
107  ENUM TypesStyle
108  C_STYLE
109  FB_STYLE
110  END ENUM
111 
112 
113  ENUM CaseModes
114  CASE_ORIGN
115  CASE_LOWER
116  CASE_MIXED
117  CASE_UPPER
118  END ENUM
119 
120  AS STRING _
121  Errr = "" _
122  , InFiles = "" _
123  , StartPath = "" _
124  , FileIncl = "" _
125  , OutPath = "" _
126  , LfnPnN = ""
127 
130  AS Parser PTR Pars = 0
133  AS EmitterIF PTR EmitIF = 0
134  AS ANY PTR DllEmitter = 0
135 #IFDEF __FB_UNIX__
136 '&ZSTRING_PTR DirUp = "../"; //!< sequence to get one directory up
137 '&/* tricky declaration for Doxygen (it miss-interpretes the @ character)
138  AS ZSTRING PTR DirUp = @"../"
139 #ELSE
140  AS ZSTRING PTR DirUp = @"..\"
141 '&*/
142 #ENDIF
143  AS INTEGER _
144  Asterix = 0 _
145  , DoCom = 0 _
146  , AllCallees = 0 _
147  , InRecursiv = 0 _
148  , InTree = 0 _
149  , Level = 0 _
150  , Efnr = 0 _
151  , Ocha = 0
152  AS UBYTE _
153  JoComm = ASC("*") _
154  , AdLine = ASC("&")
155  AS EmitFunc _
156  CreateFunction _
157  , CreateVariable
158 
159  DECLARE CONSTRUCTOR()
160  DECLARE DESTRUCTOR()
161  DECLARE FUNCTION parseCLI() AS RunModes
162  DECLARE FUNCTION parseOptpara(BYREF Idx AS INTEGER) AS STRING
163  DECLARE FUNCTION chooseEmitter(BYREF F AS STRING, BYREF AS STRING) as EmitterIF PTR
164  DECLARE SUB FileModi()
165  DECLARE SUB doFile(BYREF AS STRING)
166  DECLARE FUNCTION checkDir(BYREF AS STRING) AS INTEGER
167  DECLARE FUNCTION scanFiles(BYREF AS STRING, BYREF AS STRING) AS STRING
168  DECLARE FUNCTION addPath(BYREF AS STRING, BYREF AS STRING) AS STRING
169 END TYPE
170 
171 '&typedef Options* Options_PTR; //!< Doxygen internal (ignore this).
172 
173 COMMON SHARED AS Options PTR OPT
174 
175 ' Forward declaration of internal emitter init functions
176 DECLARE SUB init_csource(BYVAL AS EmitterIF PTR)
177 DECLARE SUB init_doxy(BYVAL AS EmitterIF PTR)
178 DECLARE SUB init_gtk(BYVAL AS EmitterIF PTR)
179 DECLARE SUB init_lfn(BYVAL AS EmitterIF PTR)
180 DECLARE SUB init_syntax(BYVAL AS EmitterIF PTR)
181