├── .clang-format ├── .clang-tidy ├── .github └── workflows │ └── c.yml ├── .gitignore ├── .travis.yml ├── COPYING ├── Makefile ├── README.md ├── clitest.c ├── clitest.txt ├── conf.doxygen ├── doc └── developers-guide.md ├── libcli.c ├── libcli.h └── libcli.spec /.clang-format: -------------------------------------------------------------------------------- 1 | BasedOnStyle: Google 2 | IndentWidth: 2 3 | ColumnLimit: 120 4 | AllowShortFunctionsOnASingleLine: Empty 5 | -------------------------------------------------------------------------------- /.clang-tidy: -------------------------------------------------------------------------------- 1 | --- 2 | Checks: 'clang-diagnostic-*,clang-analyzer-*' 3 | WarningsAsErrors: '' 4 | HeaderFilterRegex: '' 5 | AnalyzeTemporaryDtors: false 6 | FormatStyle: none 7 | User: dparrish 8 | CheckOptions: 9 | - key: cert-dcl16-c.NewSuffixes 10 | value: 'L;LL;LU;LLU' 11 | - key: cppcoreguidelines-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic 12 | value: '1' 13 | - key: google-readability-braces-around-statements.ShortStatementLines 14 | value: '1' 15 | - key: google-readability-function-size.StatementThreshold 16 | value: '800' 17 | - key: google-readability-namespace-comments.ShortNamespaceLines 18 | value: '10' 19 | - key: google-readability-namespace-comments.SpacesBeforeComments 20 | value: '2' 21 | - key: modernize-loop-convert.MaxCopySize 22 | value: '16' 23 | - key: modernize-loop-convert.MinConfidence 24 | value: reasonable 25 | - key: modernize-loop-convert.NamingStyle 26 | value: CamelCase 27 | - key: modernize-pass-by-value.IncludeStyle 28 | value: llvm 29 | - key: modernize-replace-auto-ptr.IncludeStyle 30 | value: llvm 31 | - key: modernize-use-nullptr.NullMacros 32 | value: 'NULL' 33 | ... 34 | 35 | -------------------------------------------------------------------------------- /.github/workflows/c.yml: -------------------------------------------------------------------------------- 1 | name: C CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - stable 7 | pull_request: 8 | branches: 9 | - stable 10 | 11 | jobs: 12 | build: 13 | 14 | runs-on: ubuntu-latest 15 | 16 | steps: 17 | - uses: actions/checkout@v1 18 | - name: make 19 | run: make 20 | 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.o 2 | *.a 3 | *.so 4 | *.so.* 5 | clitest 6 | compile_commands.json 7 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | os: linux 2 | arch: 3 | - amd64 4 | - ppc64le 5 | language: c 6 | script: make 7 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 489 | 490 | Also add information on how to contact you by electronic and paper mail. 491 | 492 | You should also get your employer (if you work as a programmer) or your 493 | school, if any, to sign a "copyright disclaimer" for the library, if 494 | necessary. Here is a sample; alter the names: 495 | 496 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 497 | library `Frob' (a library for tweaking knobs) written by James Random Hacker. 498 | 499 | , 1 April 1990 500 | Ty Coon, President of Vice 501 | 502 | That's all there is to it! 503 | 504 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Build dynamic library by default 2 | DYNAMIC_LIB ?= 1 3 | # Build static library by default 4 | STATIC_LIB ?= 1 5 | # Run tests by default 6 | TESTS ?= 1 7 | 8 | UNAME = $(shell sh -c 'uname -s 2>/dev/null || echo not') 9 | DESTDIR = 10 | PREFIX = /usr/local 11 | 12 | MAJOR = 1 13 | MINOR = 10 14 | REVISION = 8 15 | LIB = libcli.so 16 | LIB_STATIC = libcli.a 17 | 18 | CC = gcc 19 | AR = ar 20 | ARFLAGS = rcs 21 | DEBUG = -g 22 | OPTIM = -O3 23 | override CFLAGS += $(DEBUG) $(OPTIM) -Wall -std=c99 -pedantic -Wformat-security -Wno-format-zero-length -Werror -Wwrite-strings -Wformat -fdiagnostics-show-option -Wextra -Wsign-compare -Wcast-align -Wno-unused-parameter 24 | override LDFLAGS += -shared 25 | override LIBPATH += -L. 26 | 27 | ifeq ($(UNAME),Darwin) 28 | override LDFLAGS += -Wl,-install_name,$(LIB).$(MAJOR).$(MINOR) 29 | else 30 | override LDFLAGS += -Wl,-soname,$(LIB).$(MAJOR).$(MINOR) 31 | LIBS = -lcrypt 32 | endif 33 | 34 | ifeq (1,$(DYNAMIC_LIB)) 35 | TARGET_LIBS += $(LIB) 36 | endif 37 | ifeq (1,$(STATIC_LIB)) 38 | TARGET_LIBS += $(LIB_STATIC) 39 | endif 40 | 41 | all: $(TARGET_LIBS) $(if $(filter 1,$(TESTS)),clitest) 42 | 43 | $(LIB): libcli.o 44 | $(CC) -o $(LIB).$(MAJOR).$(MINOR).$(REVISION) $^ $(LDFLAGS) $(LIBS) 45 | -rm -f $(LIB) $(LIB).$(MAJOR).$(MINOR) 46 | ln -s $(LIB).$(MAJOR).$(MINOR).$(REVISION) $(LIB).$(MAJOR).$(MINOR) 47 | ln -s $(LIB).$(MAJOR).$(MINOR) $(LIB) 48 | 49 | $(LIB_STATIC): libcli.o 50 | $(AR) $(ARFLAGS) $@ $^ 51 | 52 | %.o: %.c 53 | $(CC) $(CPPFLAGS) $(CFLAGS) -fPIC -o $@ -c $< 54 | 55 | libcli.o: libcli.h 56 | 57 | clitest: clitest.o $(LIB) 58 | $(CC) $(CPPFLAGS) $(CFLAGS) -o $@ $< -L. -lcli 59 | 60 | clitest.exe: clitest.c libcli.o 61 | $(CC) $(CPPFLAGS) $(CFLAGS) -o $@ $< libcli.o -lws2_32 62 | 63 | clean: 64 | rm -f *.o $(LIB)* $(LIB_STATIC) clitest libcli-$(MAJOR).$(MINOR).$(REVISION).tar.gz 65 | 66 | install: $(TARGET_LIBS) 67 | install -d $(DESTDIR)$(PREFIX)/include $(DESTDIR)$(PREFIX)/lib 68 | install -m 0644 libcli.h $(DESTDIR)$(PREFIX)/include 69 | ifeq (1,$(STATIC_LIB)) 70 | install -m 0644 $(LIB_STATIC) $(DESTDIR)$(PREFIX)/lib 71 | endif 72 | ifeq (1,$(DYNAMIC_LIB)) 73 | install -m 0755 $(LIB).$(MAJOR).$(MINOR).$(REVISION) $(DESTDIR)$(PREFIX)/lib 74 | cd $(DESTDIR)$(PREFIX)/lib && \ 75 | ln -fs $(LIB).$(MAJOR).$(MINOR).$(REVISION) $(LIB).$(MAJOR).$(MINOR) && \ 76 | ln -fs $(LIB).$(MAJOR).$(MINOR) $(LIB) 77 | endif 78 | 79 | rpmprep: 80 | rm -rf libcli-$(MAJOR).$(MINOR).$(REVISION) 81 | mkdir libcli-$(MAJOR).$(MINOR).$(REVISION) 82 | cp -R libcli.c libcli.h libcli.spec clitest.c Makefile COPYING README.md doc libcli-$(MAJOR).$(MINOR).$(REVISION) 83 | tar zcvf libcli-$(MAJOR).$(MINOR).$(REVISION).tar.gz --exclude CVS --exclude *.tar.gz libcli-$(MAJOR).$(MINOR).$(REVISION) 84 | rm -rf libcli-$(MAJOR).$(MINOR).$(REVISION) 85 | 86 | rpm: rpmprep 87 | rpmbuild -ta libcli-$(MAJOR).$(MINOR).$(REVISION).tar.gz --define "debug_package %{nil}" --clean 88 | 89 | lint: 90 | clang-tidy -quiet -warnings-as-errors *.c *.h 91 | 92 | uninstall: 93 | rm -f $(DESTDIR)$(PREFIX)/include/libcli.h 94 | ifeq (1,$(STATIC_LIB)) 95 | rm -f $(DESTDIR)$(PREFIX)/lib/$(LIB_STATIC) 96 | endif 97 | ifeq (1,$(DYNAMIC_LIB)) 98 | rm -f $(DESTDIR)$(PREFIX)/lib/$(LIB).$(MAJOR).$(MINOR).$(REVISION) 99 | rm -f $(DESTDIR)$(PREFIX)/lib/$(LIB).$(MAJOR).$(MINOR) 100 | rm -f $(DESTDIR)$(PREFIX)/lib/$(LIB) 101 | endif 102 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Libcli provides a shared C library for including a Cisco-like command-line 2 | interface into other software. 3 | 4 | It’s a telnet interface which supports command-line editing, history, 5 | authentication and callbacks for a user-definable function tree. 6 | 7 | To compile: 8 | 9 | ```sh 10 | $ make 11 | $ make install 12 | ``` 13 | 14 | Note - as of version 1.10.5 you have a compile time decision on using select() 15 | or poll() in cli_loop(). The default is to use the legacy 'select()' call. 16 | If built with 'CFLAGS=-DLIBCLI_USE_POLL make' then the poll() system call will 17 | be used instead. One additional check is being made now in cli_loop() to 18 | ensure that the passed file descriptor is in range. If not, an error message 19 | will be sent and the cli_loop() will exit in the child process with CLI_ERROR. 20 | 21 | This will install `libcli.so` into `/usr/local/lib`. If you want to change the 22 | location, edit Makefile. 23 | 24 | There is a test application built called clitest. Run this and telnet to port 25 | 8000. 26 | 27 | By default, a single username and password combination is enabled. 28 | 29 | ``` 30 | Username: fred 31 | Password: nerk 32 | ``` 33 | 34 | Get help by entering `help` or hitting `?`. 35 | 36 | libcli provides support for using the arrow keys for command-line editing. Up 37 | and Down arrows will cycle through the command history, and Left & Right can be 38 | used for editing the current command line. 39 | 40 | libcli also works out the shortest way of entering a command, so if you have a 41 | command `show users | grep foobar` defined, you can enter `sh us | g foobar` if that 42 | is the shortest possible way of doing it. 43 | 44 | Enter `sh?` at the command line to get a list of commands starting with `sh` 45 | 46 | A few commands are defined in every libcli program: 47 | 48 | * `help` 49 | * `quit` 50 | * `exit` 51 | * `logout` 52 | * `history` 53 | 54 | Use in your own code: 55 | 56 | First of all, make sure you `#include ` in your C code, and link with 57 | `-lcli`. 58 | 59 | If you have any trouble with this, have a look at clitest.c for a 60 | demonstration. 61 | 62 | Start your program off with a `cli_init()`. 63 | This sets up the internal data structures required. 64 | 65 | When a user connects, they are presented with a greeting if one is set using the 66 | `cli_set_banner(banner)` function. 67 | 68 | By default, the command-line session is not authenticated, which means users 69 | will get full access as soon as they connect. As this may not be always the best 70 | thing, 2 methods of authentication are available. 71 | 72 | First, you can add username / password combinations with the 73 | `cli_allow_user(username, password)` function. When a user connects, they can 74 | connect with any of these username / password combinations. 75 | 76 | Secondly, you can add a callback using the `cli_set_auth_callback(callback)` 77 | function. This function is passed the username and password as `char *`, and must 78 | return `CLI_OK` if the user is to have access and `CLI_ERROR` if they are not. 79 | 80 | The library itself will take care of prompting the user for credentials. 81 | 82 | Commands are built using a tree-like structure. You define commands with the 83 | `cli_register_command(parent, command, callback, privilege, mode, help)` function. 84 | 85 | `parent` is a `cli_command *` reference to a previously added command. Using a 86 | parent you can build up complex commands. 87 | 88 | e.g. to provide commands `show users`, `show sessions` and `show people`, use 89 | the following sequence: 90 | 91 | ```c 92 | cli_command *c = cli_register_command(NULL, "show", NULL, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, NULL); 93 | cli_register_command(c, "sessions", fn_sessions, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, "Show the sessions connected"); 94 | cli_register_command(c, "users", fn_users, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, "Show the users connected"); 95 | cli_register_command(c, "people", fn_people, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, "Show a list of the people I like"); 96 | ``` 97 | 98 | If callback is `NULL`, the command can be used as part of a tree, but cannot be 99 | individually run. 100 | 101 | If you decide later that you don't want a command to be run, you can call 102 | `cli_unregister_command(command)`. 103 | You can use this to build dynamic command trees. 104 | 105 | It is possible to carry along a user-defined context to all command callbacks 106 | using `cli_set_context(cli, context)` and `cli_get_context(cli)` functions. 107 | 108 | 109 | You are responsible for accepting a TCP connection, and for creating a 110 | process or thread to run the cli. Once you are ready to process the 111 | connection, call `cli_loop(cli, sock)` to interact with the user on the 112 | given socket. Note that as mentioned above, if the select() call is used and 113 | sock is out of range (>= FD_SETSIZE) then cli_loop() will display an error in 114 | both the parent process and to the remote TCP connection before exiting that routine. 115 | 116 | This function will return when the user exits the cli, either by breaking the 117 | connection or entering `quit`. 118 | 119 | Call `cli_done()` to free the data structures. 120 | 121 | -------------------------------------------------------------------------------- /clitest.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #ifdef WIN32 6 | #include 7 | #include 8 | #else 9 | #include 10 | #include 11 | #include 12 | #endif 13 | #include 14 | #include 15 | #include 16 | #include 17 | #include 18 | 19 | #include "libcli.h" 20 | 21 | // vim:sw=4 tw=120 et 22 | 23 | #define CLITEST_PORT 8000 24 | #define MODE_CONFIG_INT 10 25 | 26 | #ifdef __GNUC__ 27 | #define UNUSED(d) d __attribute__((unused)) 28 | #else 29 | #define UNUSED(d) d 30 | #endif 31 | 32 | unsigned int regular_count = 0; 33 | unsigned int debug_regular = 0; 34 | 35 | struct my_context { 36 | int value; 37 | char *message; 38 | }; 39 | 40 | #ifdef WIN32 41 | typedef int socklen_t; 42 | 43 | int winsock_init() { 44 | WORD wVersionRequested; 45 | WSADATA wsaData; 46 | int err; 47 | 48 | // Start up sockets 49 | wVersionRequested = MAKEWORD(2, 2); 50 | 51 | err = WSAStartup(wVersionRequested, &wsaData); 52 | if (err != 0) { 53 | // Tell the user that we could not find a usable WinSock DLL. 54 | return 0; 55 | } 56 | 57 | /* 58 | * Confirm that the WinSock DLL supports 2.2 59 | * Note that if the DLL supports versions greater than 2.2 in addition to 60 | * 2.2, it will still return 2.2 in wVersion since that is the version we 61 | * requested. 62 | * */ 63 | if (LOBYTE(wsaData.wVersion) != 2 || HIBYTE(wsaData.wVersion) != 2) { 64 | // Tell the user that we could not find a usable WinSock DLL. 65 | WSACleanup(); 66 | return 0; 67 | } 68 | return 1; 69 | } 70 | #endif 71 | 72 | int cmd_test(struct cli_def *cli, const char *command, char *argv[], int argc) { 73 | int i; 74 | cli_print(cli, "called %s with \"%s\"", __func__, command); 75 | cli_print(cli, "%d arguments:", argc); 76 | for (i = 0; i < argc; i++) cli_print(cli, " %s", argv[i]); 77 | 78 | return CLI_OK; 79 | } 80 | 81 | int cmd_set(struct cli_def *cli, UNUSED(const char *command), char *argv[], int argc) { 82 | if (argc < 2 || strcmp(argv[0], "?") == 0) { 83 | cli_print(cli, "Specify a variable to set"); 84 | return CLI_OK; 85 | } 86 | 87 | if (strcmp(argv[1], "?") == 0) { 88 | cli_print(cli, "Specify a value"); 89 | return CLI_OK; 90 | } 91 | 92 | if (strcmp(argv[0], "regular_interval") == 0) { 93 | unsigned int sec = 0; 94 | if (!argv[1] && !*argv[1]) { 95 | cli_print(cli, "Specify a regular callback interval in seconds"); 96 | return CLI_OK; 97 | } 98 | sscanf(argv[1], "%u", &sec); 99 | if (sec < 1) { 100 | cli_print(cli, "Specify a regular callback interval in seconds"); 101 | return CLI_OK; 102 | } 103 | cli->timeout_tm.tv_sec = sec; 104 | cli->timeout_tm.tv_usec = 0; 105 | cli_print(cli, "Regular callback interval is now %d seconds", sec); 106 | return CLI_OK; 107 | } 108 | 109 | cli_print(cli, "Setting \"%s\" to \"%s\"", argv[0], argv[1]); 110 | return CLI_OK; 111 | } 112 | 113 | int cmd_config_int(struct cli_def *cli, UNUSED(const char *command), char *argv[], int argc) { 114 | if (argc < 1) { 115 | cli_print(cli, "Specify an interface to configure"); 116 | return CLI_OK; 117 | } 118 | 119 | if (strcmp(argv[0], "?") == 0) 120 | cli_print(cli, " test0/0"); 121 | 122 | else if (strcasecmp(argv[0], "test0/0") == 0) 123 | cli_set_configmode(cli, MODE_CONFIG_INT, "test"); 124 | else 125 | cli_print(cli, "Unknown interface %s", argv[0]); 126 | 127 | return CLI_OK; 128 | } 129 | 130 | int cmd_config_int_exit(struct cli_def *cli, UNUSED(const char *command), UNUSED(char *argv[]), UNUSED(int argc)) { 131 | cli_set_configmode(cli, MODE_CONFIG, NULL); 132 | return CLI_OK; 133 | } 134 | 135 | int cmd_show_regular(struct cli_def *cli, UNUSED(const char *command), char *argv[], int argc) { 136 | cli_print(cli, "cli_regular() has run %u times", regular_count); 137 | return CLI_OK; 138 | } 139 | 140 | int cmd_debug_regular(struct cli_def *cli, UNUSED(const char *command), char *argv[], int argc) { 141 | debug_regular = !debug_regular; 142 | cli_print(cli, "cli_regular() debugging is %s", debug_regular ? "enabled" : "disabled"); 143 | return CLI_OK; 144 | } 145 | 146 | int cmd_context(struct cli_def *cli, UNUSED(const char *command), UNUSED(char *argv[]), UNUSED(int argc)) { 147 | struct my_context *myctx = (struct my_context *)cli_get_context(cli); 148 | cli_print(cli, "User context has a value of %d and message saying %s", myctx->value, myctx->message); 149 | return CLI_OK; 150 | } 151 | 152 | int check_auth(const char *username, const char *password) { 153 | if (strcasecmp(username, "fred") != 0) return CLI_ERROR; 154 | if (strcasecmp(password, "nerk") != 0) return CLI_ERROR; 155 | return CLI_OK; 156 | } 157 | 158 | int regular_callback(struct cli_def *cli) { 159 | regular_count++; 160 | if (debug_regular) { 161 | cli_print(cli, "Regular callback - %u times so far", regular_count); 162 | cli_reprompt(cli); 163 | } 164 | return CLI_OK; 165 | } 166 | 167 | int check_enable(const char *password) { 168 | return !strcasecmp(password, "topsecret"); 169 | } 170 | 171 | int idle_timeout(struct cli_def *cli) { 172 | cli_print(cli, "Custom idle timeout"); 173 | return CLI_QUIT; 174 | } 175 | 176 | void pc(UNUSED(struct cli_def *cli), const char *string) { 177 | printf("%s\n", string); 178 | } 179 | 180 | #define MODE_POLYGON_TRIANGLE 20 181 | #define MODE_POLYGON_RECTANGLE 21 182 | 183 | int cmd_perimeter(struct cli_def *cli, const char *command, char *argv[], int argc) { 184 | struct cli_optarg_pair *optargs = cli_get_all_found_optargs(cli); 185 | int i = 1, numSides = 0; 186 | int perimeter = 0; 187 | int verbose_count = 0; 188 | char *verboseArg; 189 | char *shapeName = NULL; 190 | 191 | cli_print(cli, "perimeter callback, with %d args", argc); 192 | for (; optargs; optargs = optargs->next) cli_print(cli, "%d, %s=%s", i++, optargs->name, optargs->value); 193 | 194 | verboseArg = NULL; 195 | while ((verboseArg = cli_get_optarg_value(cli, "verbose", verboseArg))) { 196 | verbose_count++; 197 | } 198 | cli_print(cli, "verbose argument was seen %d times", verbose_count); 199 | 200 | shapeName = cli_get_optarg_value(cli, "shape", NULL); 201 | if (!shapeName) { 202 | cli_error(cli, "No shape name given"); 203 | return CLI_ERROR; 204 | } else if (strcmp(shapeName, "triangle") == 0) { 205 | numSides = 3; 206 | } else if (strcmp(shapeName, "rectangle") == 0) { 207 | numSides = 4; 208 | } else { 209 | cli_error(cli, "Unrecognized shape given"); 210 | return CLI_ERROR; 211 | } 212 | for (i = 1; i <= numSides; i++) { 213 | char sidename[50], *value; 214 | int length; 215 | snprintf(sidename, 50, "side_%d", i); 216 | value = cli_get_optarg_value(cli, sidename, NULL); 217 | length = strtol(value, NULL, 10); 218 | perimeter += length; 219 | } 220 | cli_print(cli, "Perimeter is %d", perimeter); 221 | return CLI_OK; 222 | } 223 | 224 | const char *KnownShapes[] = {"rectangle", "triangle", NULL}; 225 | 226 | int shape_completor(struct cli_def *cli, const char *name, const char *value, struct cli_comphelp *comphelp) { 227 | const char **shape; 228 | int rc = CLI_OK; 229 | printf("shape_completor called with <%s>\n", value); 230 | for (shape = KnownShapes; *shape && (rc == CLI_OK); shape++) { 231 | if (!value || !strncmp(*shape, value, strlen(value))) { 232 | rc = cli_add_comphelp_entry(comphelp, *shape); 233 | } 234 | } 235 | return rc; 236 | } 237 | 238 | int shape_validator(struct cli_def *cli, const char *name, const char *value) { 239 | const char **shape; 240 | 241 | printf("shape_validator called with <%s>\n", value); 242 | for (shape = KnownShapes; *shape; shape++) { 243 | if (!strcmp(value, *shape)) return CLI_OK; 244 | } 245 | return CLI_ERROR; 246 | } 247 | 248 | int verbose_validator(struct cli_def *cli, const char *name, const char *value) { 249 | printf("verbose_validator called\n"); 250 | return CLI_OK; 251 | } 252 | 253 | // note that we're setting a 'custom' optarg tag/value pair as an example here 254 | int shape_transient_eval(struct cli_def *cli, const char *name, const char *value) { 255 | printf("shape_transient_eval called with <%s>\n", value); 256 | if (!strcmp(value, "rectangle")) { 257 | cli_set_transient_mode(cli, MODE_POLYGON_RECTANGLE); 258 | cli_set_optarg_value(cli, "duplicateShapeValue", value, 0); 259 | return CLI_OK; 260 | } else if (!strcmp(value, "triangle")) { 261 | cli_set_transient_mode(cli, MODE_POLYGON_TRIANGLE); 262 | cli_set_optarg_value(cli, "duplicateShapeValue", value, 0); 263 | return CLI_OK; 264 | } 265 | cli_error(cli, "unrecognized value for setting %s -> %s", name, value); 266 | return CLI_ERROR; 267 | } 268 | 269 | const char *KnownColors[] = {"black", "white", "gray", "red", "blue", 270 | "green", "lightred", "lightblue", "lightgreen", "darkred", 271 | "darkblue", "darkgreen", "lavender", "yellow", NULL}; 272 | 273 | int color_completor(struct cli_def *cli, const char *name, const char *word, struct cli_comphelp *comphelp) { 274 | // Attempt to show matches against the following color strings 275 | const char **color; 276 | int rc = CLI_OK; 277 | printf("color_completor called with <%s>\n", word); 278 | for (color = KnownColors; *color && (rc == CLI_OK); color++) { 279 | if (!word || !strncmp(*color, word, strlen(word))) { 280 | rc = cli_add_comphelp_entry(comphelp, *color); 281 | } 282 | } 283 | return rc; 284 | } 285 | 286 | int color_validator(struct cli_def *cli, const char *name, const char *value) { 287 | const char **color; 288 | int rc = CLI_ERROR; 289 | printf("color_validator called for %s\n", name); 290 | for (color = KnownColors; *color; color++) { 291 | if (!strcmp(value, *color)) return CLI_OK; 292 | } 293 | return rc; 294 | } 295 | 296 | int side_length_validator(struct cli_def *cli, const char *name, const char *value) { 297 | // Verify 'value' is a positive number 298 | long len; 299 | char *endptr; 300 | int rc = CLI_OK; 301 | 302 | printf("side_length_validator called\n"); 303 | errno = 0; 304 | len = strtol(value, &endptr, 10); 305 | if ((endptr == value) || (*endptr != '\0') || ((errno == ERANGE) && ((len == LONG_MIN) || (len == LONG_MAX)))) 306 | return CLI_ERROR; 307 | return rc; 308 | } 309 | 310 | int transparent_validator(struct cli_def *cli, const char *name, const char *value) { 311 | return strcasecmp("transparent", value) ? CLI_ERROR : CLI_OK; 312 | } 313 | 314 | int check1_validator(struct cli_def *cli, UNUSED(const char *name), UNUSED(const char *value)) { 315 | char *color; 316 | char *transparent; 317 | 318 | printf("check1_validator called \n"); 319 | color = cli_get_optarg_value(cli, "color", NULL); 320 | transparent = cli_get_optarg_value(cli, "transparent", NULL); 321 | 322 | if (!color && !transparent) { 323 | cli_error(cli, "\nMust supply either a color or transparent!"); 324 | return CLI_ERROR; 325 | } else if (color && !strcmp(color, "black") && transparent) { 326 | cli_error(cli, "\nCan not have a transparent black object!"); 327 | return CLI_ERROR; 328 | } 329 | return CLI_OK; 330 | } 331 | 332 | int cmd_deep_dive(struct cli_def *cli, const char *command, char *argv[], int argc) { 333 | cli_print(cli, "Raw commandline was <%s>", cli->pipeline->cmdline); 334 | return CLI_OK; 335 | } 336 | 337 | int int_validator(struct cli_def *cli, const char *name, const char *value) { 338 | // Verify 'value' is a positive number 339 | long len; 340 | char *endptr; 341 | int rc = CLI_OK; 342 | 343 | printf("int_validator called\n"); 344 | errno = 0; 345 | len = strtol(value, &endptr, 10); 346 | if ((endptr == value) || (*endptr != '\0') || ((errno == ERANGE) && ((len == LONG_MIN) || (len == LONG_MAX)))) 347 | return CLI_ERROR; 348 | return rc; 349 | } 350 | 351 | int cmd_string(struct cli_def *cli, const char *command, char *argv[], int argc) { 352 | int i; 353 | cli_print(cli, "Raw commandline was <%s>", cli->pipeline->cmdline); 354 | cli_print(cli, "Value for text argument is <%s>", cli_get_optarg_value(cli, "text", NULL)); 355 | 356 | cli_print(cli, "Found %d 'extra' arguments after 'text' argument was processed", argc); 357 | for (i = 0; i != argc; i++) { 358 | cli_print(cli, " Extra arg %d = <%s>", i + 1, argv[i]); 359 | } 360 | return CLI_OK; 361 | } 362 | int cmd_long_name(struct cli_def *cli, const char *command, char *argv[], int argc) { 363 | int i; 364 | cli_print(cli, "Raw commandline was <%s>", cli->pipeline->cmdline); 365 | cli_print(cli, "Value for text argument is <%s>", cli_get_optarg_value(cli, "text", NULL)); 366 | 367 | cli_print(cli, "Found %d 'extra' arguments after 'text' argument was processed", argc); 368 | for (i = 0; i != argc; i++) { 369 | cli_print(cli, " Extra arg %d = <%s>", i + 1, argv[i]); 370 | } 371 | return CLI_OK; 372 | } 373 | 374 | void run_child(int x) { 375 | struct cli_command *c; 376 | struct cli_def *cli; 377 | struct cli_optarg *o; 378 | 379 | // Prepare a small user context 380 | char mymessage[] = "I contain user data!"; 381 | struct my_context myctx; 382 | myctx.value = 5; 383 | myctx.message = mymessage; 384 | 385 | cli = cli_init(); 386 | cli_set_banner(cli, "libcli test environment"); 387 | cli_set_hostname(cli, "router"); 388 | cli_telnet_protocol(cli, 1); 389 | cli_regular(cli, regular_callback); 390 | 391 | // change regular update to 5 seconds rather than default of 1 second 392 | cli_regular_interval(cli, 5); 393 | 394 | // set 60 second idle timeout 395 | cli_set_idle_timeout_callback(cli, 60, idle_timeout); 396 | cli_register_command(cli, NULL, "test", cmd_test, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, NULL); 397 | cli_register_command(cli, NULL, "simple", NULL, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, NULL); 398 | cli_register_command(cli, NULL, "simon", NULL, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, NULL); 399 | cli_register_command(cli, NULL, "set", cmd_set, PRIVILEGE_PRIVILEGED, MODE_EXEC, NULL); 400 | c = cli_register_command(cli, NULL, "show", NULL, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, NULL); 401 | cli_register_command(cli, c, "regular", cmd_show_regular, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, 402 | "Show the how many times cli_regular has run"); 403 | cli_register_command(cli, c, "counters", cmd_test, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, 404 | "Show the counters that the system uses"); 405 | cli_register_command(cli, c, "junk", cmd_test, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, NULL); 406 | cli_register_command(cli, NULL, "interface", cmd_config_int, PRIVILEGE_PRIVILEGED, MODE_CONFIG, 407 | "Configure an interface"); 408 | cli_register_command(cli, NULL, "exit", cmd_config_int_exit, PRIVILEGE_PRIVILEGED, MODE_CONFIG_INT, 409 | "Exit from interface configuration"); 410 | cli_register_command(cli, NULL, "address", cmd_test, PRIVILEGE_PRIVILEGED, MODE_CONFIG_INT, "Set IP address"); 411 | c = cli_register_command(cli, NULL, "debug", NULL, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, NULL); 412 | cli_register_command(cli, c, "regular", cmd_debug_regular, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, 413 | "Enable cli_regular() callback debugging"); 414 | 415 | // Register some commands/subcommands to demonstrate opt/arg and buildmode operations 416 | 417 | c = cli_register_command( 418 | cli, NULL, "perimeter", cmd_perimeter, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, 419 | "Calculate perimeter of polygon\nhas embedded " 420 | "newline\nand_a_really_long_line_that_is_much_longer_than_80_columns_to_show_that_wrap_case"); 421 | o = cli_register_optarg(c, "transparent", CLI_CMD_OPTIONAL_FLAG, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, 422 | "Set transparent flag", NULL, NULL, NULL); 423 | cli_optarg_addhelp(o, "transparent", "(any case)set to transparent"); 424 | 425 | cli_register_optarg( 426 | c, "verbose", CLI_CMD_OPTIONAL_FLAG | CLI_CMD_OPTION_MULTIPLE, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, 427 | "Set verbose flag with some humongously long string \nwithout any embedded newlines in it to test with", NULL, 428 | NULL, NULL); 429 | o = cli_register_optarg(c, "color", CLI_CMD_OPTIONAL_ARGUMENT, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, "Set color", 430 | color_completor, color_validator, NULL); 431 | cli_optarg_addhelp(o, "black", "the color 'black'"); 432 | cli_optarg_addhelp(o, "white", "the color 'white'"); 433 | cli_optarg_addhelp(o, "gray", "the color 'gray'"); 434 | cli_optarg_addhelp(o, "red", "the color 'red'"); 435 | cli_optarg_addhelp(o, "blue", "the color 'blue'"); 436 | cli_optarg_addhelp(o, "green", "the color 'green'"); 437 | cli_optarg_addhelp(o, "lightred", "the color 'lightred'"); 438 | cli_optarg_addhelp(o, "lightblue", "the color 'lightblue'"); 439 | cli_optarg_addhelp(o, "lightgreen", "the color 'lightgreen'"); 440 | cli_optarg_addhelp(o, "darkred", "the color 'darkred'"); 441 | cli_optarg_addhelp(o, "darkblue", "the color 'darkblue'"); 442 | cli_optarg_addhelp(o, "darkgreen", "the color 'darkgreen'"); 443 | cli_optarg_addhelp(o, "lavender", "the color 'lavender'"); 444 | cli_optarg_addhelp(o, "yellow", "the color 'yellow'"); 445 | 446 | cli_register_optarg(c, "__check1__", CLI_CMD_SPOT_CHECK, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, NULL, NULL, 447 | check1_validator, NULL); 448 | o = cli_register_optarg(c, "shape", CLI_CMD_ARGUMENT | CLI_CMD_ALLOW_BUILDMODE, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, 449 | "Specify shape(shows subtext on help)", shape_completor, shape_validator, 450 | shape_transient_eval); 451 | cli_optarg_addhelp(o, "triangle", "specify a triangle"); 452 | cli_optarg_addhelp(o, "rectangle", "specify a rectangle"); 453 | 454 | cli_register_optarg(c, "side_1", CLI_CMD_ARGUMENT, PRIVILEGE_UNPRIVILEGED, MODE_POLYGON_TRIANGLE, 455 | "Specify side 1 length", NULL, side_length_validator, NULL); 456 | cli_register_optarg(c, "side_1", CLI_CMD_ARGUMENT, PRIVILEGE_UNPRIVILEGED, MODE_POLYGON_RECTANGLE, 457 | "Specify side 1 length", NULL, side_length_validator, NULL); 458 | cli_register_optarg(c, "side_2", CLI_CMD_ARGUMENT, PRIVILEGE_UNPRIVILEGED, MODE_POLYGON_TRIANGLE, 459 | "Specify side 2 length", NULL, side_length_validator, NULL); 460 | cli_register_optarg(c, "side_2", CLI_CMD_ARGUMENT, PRIVILEGE_UNPRIVILEGED, MODE_POLYGON_RECTANGLE, 461 | "Specify side 2 length", NULL, side_length_validator, NULL); 462 | cli_register_optarg(c, "side_3", CLI_CMD_ARGUMENT, PRIVILEGE_UNPRIVILEGED, MODE_POLYGON_TRIANGLE, 463 | "Specify side 3 length", NULL, side_length_validator, NULL); 464 | cli_register_optarg(c, "side_3", CLI_CMD_ARGUMENT, PRIVILEGE_UNPRIVILEGED, MODE_POLYGON_RECTANGLE, 465 | "Specify side 3 length", NULL, side_length_validator, NULL); 466 | cli_register_optarg(c, "side_4", CLI_CMD_ARGUMENT, PRIVILEGE_UNPRIVILEGED, MODE_POLYGON_RECTANGLE, 467 | "Specify side 4 length", NULL, side_length_validator, NULL); 468 | 469 | c = cli_register_command(cli, NULL, "string", cmd_string, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, 470 | "string input argument testing"); 471 | 472 | cli_register_optarg(c, "buildmode", CLI_CMD_OPTIONAL_FLAG | CLI_CMD_ALLOW_BUILDMODE, PRIVILEGE_UNPRIVILEGED, 473 | MODE_EXEC, "flag", NULL, NULL, NULL); 474 | cli_register_optarg(c, "text", CLI_CMD_ARGUMENT, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, "text string", NULL, NULL, NULL); 475 | 476 | // Set user context and its command 477 | cli_set_context(cli, (void *)&myctx); 478 | cli_register_command(cli, NULL, "context", cmd_context, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, 479 | "Test a user-specified context"); 480 | 481 | struct cli_command *d1, *d2, *d3; 482 | 483 | d1 = cli_register_command(cli, NULL, "deep", NULL, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, "top level deep dive cmd"); 484 | d2 = cli_register_command(cli, d1, "dive", NULL, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, "mid level dep dive cmd"); 485 | d3 = cli_register_command(cli, d2, "cmd", cmd_deep_dive, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, 486 | "bottom level dep dive cmd"); 487 | o = cli_register_optarg(d3, "howdeep", CLI_CMD_ARGUMENT, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, "Specify how deep", NULL, 488 | int_validator, NULL); 489 | o = cli_register_optarg(d3, "howlong", CLI_CMD_OPTIONAL_ARGUMENT, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, 490 | "Specify how long", NULL, int_validator, NULL); 491 | 492 | c = cli_register_command( 493 | cli, NULL, "serioously_long_cammand_to_test_with", cmd_long_name, PRIVILEGE_UNPRIVILEGED, MODE_EXEC, 494 | "show long command name with " 495 | "newline\nand_a_really_long_line_that_is_much_longer_than_80_columns_to_show_that_wrap_case"); 496 | 497 | cli_set_auth_callback(cli, check_auth); 498 | cli_set_enable_callback(cli, check_enable); 499 | // Test reading from a file 500 | { 501 | FILE *fh; 502 | 503 | if ((fh = fopen("clitest.txt", "r"))) { 504 | // This sets a callback which just displays the cli_print() text to stdout 505 | cli_print_callback(cli, pc); 506 | cli_file(cli, fh, PRIVILEGE_UNPRIVILEGED, MODE_EXEC); 507 | cli_print_callback(cli, NULL); 508 | fclose(fh); 509 | } 510 | } 511 | cli_loop(cli, x); 512 | cli_done(cli); 513 | } 514 | 515 | int main() { 516 | int s, x; 517 | struct sockaddr_in addr; 518 | int on = 1; 519 | 520 | #ifndef WIN32 521 | signal(SIGCHLD, SIG_IGN); 522 | #endif 523 | #ifdef WIN32 524 | if (!winsock_init()) { 525 | printf("Error initialising winsock\n"); 526 | return 1; 527 | } 528 | #endif 529 | 530 | if ((s = socket(AF_INET, SOCK_STREAM, 0)) < 0) { 531 | perror("socket"); 532 | return 1; 533 | } 534 | 535 | if (setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on))) { 536 | perror("setsockopt"); 537 | } 538 | 539 | memset(&addr, 0, sizeof(addr)); 540 | addr.sin_family = AF_INET; 541 | addr.sin_addr.s_addr = htonl(INADDR_ANY); 542 | addr.sin_port = htons(CLITEST_PORT); 543 | if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) { 544 | perror("bind"); 545 | return 1; 546 | } 547 | 548 | if (listen(s, 50) < 0) { 549 | perror("listen"); 550 | return 1; 551 | } 552 | 553 | printf("Listening on port %d\n", CLITEST_PORT); 554 | while ((x = accept(s, NULL, 0))) { 555 | #ifndef WIN32 556 | int pid = fork(); 557 | if (pid < 0) { 558 | perror("fork"); 559 | return 1; 560 | } 561 | 562 | /* parent */ 563 | if (pid > 0) { 564 | socklen_t len = sizeof(addr); 565 | if (getpeername(x, (struct sockaddr *)&addr, &len) >= 0) 566 | printf(" * accepted connection from %s\n", inet_ntoa(addr.sin_addr)); 567 | 568 | close(x); 569 | continue; 570 | } 571 | 572 | /* child */ 573 | close(s); 574 | run_child(x); 575 | exit(0); 576 | #else 577 | run_child(x); 578 | shutdown(x, SD_BOTH); 579 | close(x); 580 | #endif 581 | } 582 | 583 | return 0; 584 | } 585 | -------------------------------------------------------------------------------- /clitest.txt: -------------------------------------------------------------------------------- 1 | show counters 2 | -------------------------------------------------------------------------------- /conf.doxygen: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.13 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "libcli" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = "more beautiful wrapper around posix mq and shm" 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = "doc" 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = "The $name class" \ 122 | "The $name widget" \ 123 | "The $name file" \ 124 | is \ 125 | provides \ 126 | specifies \ 127 | contains \ 128 | represents \ 129 | a \ 130 | an \ 131 | the 132 | 133 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134 | # doxygen will generate a detailed section even if there is only a brief 135 | # description. 136 | # The default value is: NO. 137 | 138 | ALWAYS_DETAILED_SEC = NO 139 | 140 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141 | # inherited members of a class in the documentation of that class as if those 142 | # members were ordinary class members. Constructors, destructors and assignment 143 | # operators of the base classes will not be shown. 144 | # The default value is: NO. 145 | 146 | INLINE_INHERITED_MEMB = NO 147 | 148 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 149 | # before files name in the file list and in the header files. If set to NO the 150 | # shortest path that makes the file name unique will be used 151 | # The default value is: YES. 152 | 153 | FULL_PATH_NAMES = YES 154 | 155 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156 | # Stripping is only done if one of the specified strings matches the left-hand 157 | # part of the path. The tag can be used to show relative paths in the file list. 158 | # If left blank the directory from which doxygen is run is used as the path to 159 | # strip. 160 | # 161 | # Note that you can specify absolute paths here, but also relative paths, which 162 | # will be relative from the directory where doxygen is started. 163 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 164 | 165 | STRIP_FROM_PATH = 166 | 167 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168 | # path mentioned in the documentation of a class, which tells the reader which 169 | # header file to include in order to use a class. If left blank only the name of 170 | # the header file containing the class definition is used. Otherwise one should 171 | # specify the list of include paths that are normally passed to the compiler 172 | # using the -I flag. 173 | 174 | STRIP_FROM_INC_PATH = 175 | 176 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177 | # less readable) file names. This can be useful is your file systems doesn't 178 | # support long names like on DOS, Mac, or CD-ROM. 179 | # The default value is: NO. 180 | 181 | SHORT_NAMES = NO 182 | 183 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184 | # first line (until the first dot) of a Javadoc-style comment as the brief 185 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 186 | # style comments (thus requiring an explicit @brief command for a brief 187 | # description.) 188 | # The default value is: NO. 189 | 190 | JAVADOC_AUTOBRIEF = NO 191 | 192 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193 | # line (until the first dot) of a Qt-style comment as the brief description. If 194 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195 | # requiring an explicit \brief command for a brief description.) 196 | # The default value is: NO. 197 | 198 | QT_AUTOBRIEF = NO 199 | 200 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202 | # a brief description. This used to be the default behavior. The new default is 203 | # to treat a multi-line C++ comment block as a detailed description. Set this 204 | # tag to YES if you prefer the old behavior instead. 205 | # 206 | # Note that setting this tag to YES also means that rational rose comments are 207 | # not recognized any more. 208 | # The default value is: NO. 209 | 210 | MULTILINE_CPP_IS_BRIEF = NO 211 | 212 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213 | # documentation from any documented member that it re-implements. 214 | # The default value is: YES. 215 | 216 | INHERIT_DOCS = YES 217 | 218 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 219 | # page for each member. If set to NO, the documentation of a member will be part 220 | # of the file/class/namespace that contains it. 221 | # The default value is: NO. 222 | 223 | SEPARATE_MEMBER_PAGES = NO 224 | 225 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226 | # uses this value to replace tabs by spaces in code fragments. 227 | # Minimum value: 1, maximum value: 16, default value: 4. 228 | 229 | TAB_SIZE = 4 230 | 231 | # This tag can be used to specify a number of aliases that act as commands in 232 | # the documentation. An alias has the form: 233 | # name=value 234 | # For example adding 235 | # "sideeffect=@par Side Effects:\n" 236 | # will allow you to put the command \sideeffect (or @sideeffect) in the 237 | # documentation, which will result in a user-defined paragraph with heading 238 | # "Side Effects:". You can put \n's in the value part of an alias to insert 239 | # newlines. 240 | 241 | ALIASES = 242 | 243 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 244 | # A mapping has the form "name=value". For example adding "class=itcl::class" 245 | # will allow you to use the command class in the itcl::class meaning. 246 | 247 | TCL_SUBST = 248 | 249 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250 | # only. Doxygen will then generate output that is more tailored for C. For 251 | # instance, some of the names that are used will be different. The list of all 252 | # members will be omitted, etc. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_FOR_C = NO 256 | 257 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258 | # Python sources only. Doxygen will then generate output that is more tailored 259 | # for that language. For instance, namespaces will be presented as packages, 260 | # qualified scopes will look different, etc. 261 | # The default value is: NO. 262 | 263 | OPTIMIZE_OUTPUT_JAVA = NO 264 | 265 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266 | # sources. Doxygen will then generate output that is tailored for Fortran. 267 | # The default value is: NO. 268 | 269 | OPTIMIZE_FOR_FORTRAN = NO 270 | 271 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272 | # sources. Doxygen will then generate output that is tailored for VHDL. 273 | # The default value is: NO. 274 | 275 | OPTIMIZE_OUTPUT_VHDL = NO 276 | 277 | # Doxygen selects the parser to use depending on the extension of the files it 278 | # parses. With this tag you can assign which parser to use for a given 279 | # extension. Doxygen has a built-in mapping, but you can override or extend it 280 | # using this tag. The format is ext=language, where ext is a file extension, and 281 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284 | # Fortran. In the later case the parser tries to guess whether the code is fixed 285 | # or free formatted code, this is the default for Fortran type files), VHDL. For 286 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 287 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 288 | # 289 | # Note: For files without extension you can use no_extension as a placeholder. 290 | # 291 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292 | # the files are not read by doxygen. 293 | 294 | EXTENSION_MAPPING = 295 | 296 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297 | # according to the Markdown format, which allows for more readable 298 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 299 | # The output of markdown processing is further processed by doxygen, so you can 300 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301 | # case of backward compatibilities issues. 302 | # The default value is: YES. 303 | 304 | MARKDOWN_SUPPORT = YES 305 | 306 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 307 | # to that level are automatically included in the table of contents, even if 308 | # they do not have an id attribute. 309 | # Note: This feature currently applies only to Markdown headings. 310 | # Minimum value: 0, maximum value: 99, default value: 0. 311 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 312 | 313 | TOC_INCLUDE_HEADINGS = 0 314 | 315 | # When enabled doxygen tries to link words that correspond to documented 316 | # classes, or namespaces to their corresponding documentation. Such a link can 317 | # be prevented in individual cases by putting a % sign in front of the word or 318 | # globally by setting AUTOLINK_SUPPORT to NO. 319 | # The default value is: YES. 320 | 321 | AUTOLINK_SUPPORT = YES 322 | 323 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 324 | # to include (a tag file for) the STL sources as input, then you should set this 325 | # tag to YES in order to let doxygen match functions declarations and 326 | # definitions whose arguments contain STL classes (e.g. func(std::string); 327 | # versus func(std::string) {}). This also make the inheritance and collaboration 328 | # diagrams that involve STL classes more complete and accurate. 329 | # The default value is: NO. 330 | 331 | BUILTIN_STL_SUPPORT = NO 332 | 333 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 334 | # enable parsing support. 335 | # The default value is: NO. 336 | 337 | CPP_CLI_SUPPORT = NO 338 | 339 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 340 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 341 | # will parse them like normal C++ but will assume all classes use public instead 342 | # of private inheritance when no explicit protection keyword is present. 343 | # The default value is: NO. 344 | 345 | SIP_SUPPORT = NO 346 | 347 | # For Microsoft's IDL there are propget and propput attributes to indicate 348 | # getter and setter methods for a property. Setting this option to YES will make 349 | # doxygen to replace the get and set methods by a property in the documentation. 350 | # This will only work if the methods are indeed getting or setting a simple 351 | # type. If this is not the case, or you want to show the methods anyway, you 352 | # should set this option to NO. 353 | # The default value is: YES. 354 | 355 | IDL_PROPERTY_SUPPORT = YES 356 | 357 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 358 | # tag is set to YES then doxygen will reuse the documentation of the first 359 | # member in the group (if any) for the other members of the group. By default 360 | # all members of a group must be documented explicitly. 361 | # The default value is: NO. 362 | 363 | DISTRIBUTE_GROUP_DOC = NO 364 | 365 | # If one adds a struct or class to a group and this option is enabled, then also 366 | # any nested class or struct is added to the same group. By default this option 367 | # is disabled and one has to add nested compounds explicitly via \ingroup. 368 | # The default value is: NO. 369 | 370 | GROUP_NESTED_COMPOUNDS = NO 371 | 372 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 373 | # (for instance a group of public functions) to be put as a subgroup of that 374 | # type (e.g. under the Public Functions section). Set it to NO to prevent 375 | # subgrouping. Alternatively, this can be done per class using the 376 | # \nosubgrouping command. 377 | # The default value is: YES. 378 | 379 | SUBGROUPING = YES 380 | 381 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 382 | # are shown inside the group in which they are included (e.g. using \ingroup) 383 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 384 | # and RTF). 385 | # 386 | # Note that this feature does not work in combination with 387 | # SEPARATE_MEMBER_PAGES. 388 | # The default value is: NO. 389 | 390 | INLINE_GROUPED_CLASSES = NO 391 | 392 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 393 | # with only public data fields or simple typedef fields will be shown inline in 394 | # the documentation of the scope in which they are defined (i.e. file, 395 | # namespace, or group documentation), provided this scope is documented. If set 396 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 397 | # Man pages) or section (for LaTeX and RTF). 398 | # The default value is: NO. 399 | 400 | INLINE_SIMPLE_STRUCTS = NO 401 | 402 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 403 | # enum is documented as struct, union, or enum with the name of the typedef. So 404 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 405 | # with name TypeT. When disabled the typedef will appear as a member of a file, 406 | # namespace, or class. And the struct will be named TypeS. This can typically be 407 | # useful for C code in case the coding convention dictates that all compound 408 | # types are typedef'ed and only the typedef is referenced, never the tag name. 409 | # The default value is: NO. 410 | 411 | TYPEDEF_HIDES_STRUCT = NO 412 | 413 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 414 | # cache is used to resolve symbols given their name and scope. Since this can be 415 | # an expensive process and often the same symbol appears multiple times in the 416 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 417 | # doxygen will become slower. If the cache is too large, memory is wasted. The 418 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 419 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 420 | # symbols. At the end of a run doxygen will report the cache usage and suggest 421 | # the optimal cache size from a speed point of view. 422 | # Minimum value: 0, maximum value: 9, default value: 0. 423 | 424 | LOOKUP_CACHE_SIZE = 0 425 | 426 | #--------------------------------------------------------------------------- 427 | # Build related configuration options 428 | #--------------------------------------------------------------------------- 429 | 430 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 431 | # documentation are documented, even if no documentation was available. Private 432 | # class members and static file members will be hidden unless the 433 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 434 | # Note: This will also disable the warnings about undocumented members that are 435 | # normally produced when WARNINGS is set to YES. 436 | # The default value is: NO. 437 | 438 | EXTRACT_ALL = YES 439 | 440 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 441 | # be included in the documentation. 442 | # The default value is: NO. 443 | 444 | EXTRACT_PRIVATE = NO 445 | 446 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 447 | # scope will be included in the documentation. 448 | # The default value is: NO. 449 | 450 | EXTRACT_PACKAGE = NO 451 | 452 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 453 | # included in the documentation. 454 | # The default value is: NO. 455 | 456 | EXTRACT_STATIC = NO 457 | 458 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 459 | # locally in source files will be included in the documentation. If set to NO, 460 | # only classes defined in header files are included. Does not have any effect 461 | # for Java sources. 462 | # The default value is: YES. 463 | 464 | EXTRACT_LOCAL_CLASSES = YES 465 | 466 | # This flag is only useful for Objective-C code. If set to YES, local methods, 467 | # which are defined in the implementation section but not in the interface are 468 | # included in the documentation. If set to NO, only methods in the interface are 469 | # included. 470 | # The default value is: NO. 471 | 472 | EXTRACT_LOCAL_METHODS = NO 473 | 474 | # If this flag is set to YES, the members of anonymous namespaces will be 475 | # extracted and appear in the documentation as a namespace called 476 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 477 | # the file that contains the anonymous namespace. By default anonymous namespace 478 | # are hidden. 479 | # The default value is: NO. 480 | 481 | EXTRACT_ANON_NSPACES = NO 482 | 483 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 484 | # undocumented members inside documented classes or files. If set to NO these 485 | # members will be included in the various overviews, but no documentation 486 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 487 | # The default value is: NO. 488 | 489 | HIDE_UNDOC_MEMBERS = NO 490 | 491 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 492 | # undocumented classes that are normally visible in the class hierarchy. If set 493 | # to NO, these classes will be included in the various overviews. This option 494 | # has no effect if EXTRACT_ALL is enabled. 495 | # The default value is: NO. 496 | 497 | HIDE_UNDOC_CLASSES = NO 498 | 499 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 500 | # (class|struct|union) declarations. If set to NO, these declarations will be 501 | # included in the documentation. 502 | # The default value is: NO. 503 | 504 | HIDE_FRIEND_COMPOUNDS = NO 505 | 506 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 507 | # documentation blocks found inside the body of a function. If set to NO, these 508 | # blocks will be appended to the function's detailed documentation block. 509 | # The default value is: NO. 510 | 511 | HIDE_IN_BODY_DOCS = NO 512 | 513 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 514 | # \internal command is included. If the tag is set to NO then the documentation 515 | # will be excluded. Set it to YES to include the internal documentation. 516 | # The default value is: NO. 517 | 518 | INTERNAL_DOCS = NO 519 | 520 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 521 | # names in lower-case letters. If set to YES, upper-case letters are also 522 | # allowed. This is useful if you have classes or files whose names only differ 523 | # in case and if your file system supports case sensitive file names. Windows 524 | # and Mac users are advised to set this option to NO. 525 | # The default value is: system dependent. 526 | 527 | CASE_SENSE_NAMES = YES 528 | 529 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 530 | # their full class and namespace scopes in the documentation. If set to YES, the 531 | # scope will be hidden. 532 | # The default value is: NO. 533 | 534 | HIDE_SCOPE_NAMES = NO 535 | 536 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 537 | # append additional text to a page's title, such as Class Reference. If set to 538 | # YES the compound reference will be hidden. 539 | # The default value is: NO. 540 | 541 | HIDE_COMPOUND_REFERENCE= NO 542 | 543 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 544 | # the files that are included by a file in the documentation of that file. 545 | # The default value is: YES. 546 | 547 | SHOW_INCLUDE_FILES = YES 548 | 549 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 550 | # grouped member an include statement to the documentation, telling the reader 551 | # which file to include in order to use the member. 552 | # The default value is: NO. 553 | 554 | SHOW_GROUPED_MEMB_INC = NO 555 | 556 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 557 | # files with double quotes in the documentation rather than with sharp brackets. 558 | # The default value is: NO. 559 | 560 | FORCE_LOCAL_INCLUDES = NO 561 | 562 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 563 | # documentation for inline members. 564 | # The default value is: YES. 565 | 566 | INLINE_INFO = YES 567 | 568 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 569 | # (detailed) documentation of file and class members alphabetically by member 570 | # name. If set to NO, the members will appear in declaration order. 571 | # The default value is: YES. 572 | 573 | SORT_MEMBER_DOCS = YES 574 | 575 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 576 | # descriptions of file, namespace and class members alphabetically by member 577 | # name. If set to NO, the members will appear in declaration order. Note that 578 | # this will also influence the order of the classes in the class list. 579 | # The default value is: NO. 580 | 581 | SORT_BRIEF_DOCS = NO 582 | 583 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 584 | # (brief and detailed) documentation of class members so that constructors and 585 | # destructors are listed first. If set to NO the constructors will appear in the 586 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 587 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 588 | # member documentation. 589 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 590 | # detailed member documentation. 591 | # The default value is: NO. 592 | 593 | SORT_MEMBERS_CTORS_1ST = NO 594 | 595 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 596 | # of group names into alphabetical order. If set to NO the group names will 597 | # appear in their defined order. 598 | # The default value is: NO. 599 | 600 | SORT_GROUP_NAMES = NO 601 | 602 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 603 | # fully-qualified names, including namespaces. If set to NO, the class list will 604 | # be sorted only by class name, not including the namespace part. 605 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 606 | # Note: This option applies only to the class list, not to the alphabetical 607 | # list. 608 | # The default value is: NO. 609 | 610 | SORT_BY_SCOPE_NAME = NO 611 | 612 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 613 | # type resolution of all parameters of a function it will reject a match between 614 | # the prototype and the implementation of a member function even if there is 615 | # only one candidate or it is obvious which candidate to choose by doing a 616 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 617 | # accept a match between prototype and implementation in such cases. 618 | # The default value is: NO. 619 | 620 | STRICT_PROTO_MATCHING = NO 621 | 622 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 623 | # list. This list is created by putting \todo commands in the documentation. 624 | # The default value is: YES. 625 | 626 | GENERATE_TODOLIST = YES 627 | 628 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 629 | # list. This list is created by putting \test commands in the documentation. 630 | # The default value is: YES. 631 | 632 | GENERATE_TESTLIST = YES 633 | 634 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 635 | # list. This list is created by putting \bug commands in the documentation. 636 | # The default value is: YES. 637 | 638 | GENERATE_BUGLIST = YES 639 | 640 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 641 | # the deprecated list. This list is created by putting \deprecated commands in 642 | # the documentation. 643 | # The default value is: YES. 644 | 645 | GENERATE_DEPRECATEDLIST= YES 646 | 647 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 648 | # sections, marked by \if ... \endif and \cond 649 | # ... \endcond blocks. 650 | 651 | ENABLED_SECTIONS = 652 | 653 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 654 | # initial value of a variable or macro / define can have for it to appear in the 655 | # documentation. If the initializer consists of more lines than specified here 656 | # it will be hidden. Use a value of 0 to hide initializers completely. The 657 | # appearance of the value of individual variables and macros / defines can be 658 | # controlled using \showinitializer or \hideinitializer command in the 659 | # documentation regardless of this setting. 660 | # Minimum value: 0, maximum value: 10000, default value: 30. 661 | 662 | MAX_INITIALIZER_LINES = 30 663 | 664 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 665 | # the bottom of the documentation of classes and structs. If set to YES, the 666 | # list will mention the files that were used to generate the documentation. 667 | # The default value is: YES. 668 | 669 | SHOW_USED_FILES = YES 670 | 671 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 672 | # will remove the Files entry from the Quick Index and from the Folder Tree View 673 | # (if specified). 674 | # The default value is: YES. 675 | 676 | SHOW_FILES = YES 677 | 678 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 679 | # page. This will remove the Namespaces entry from the Quick Index and from the 680 | # Folder Tree View (if specified). 681 | # The default value is: YES. 682 | 683 | SHOW_NAMESPACES = YES 684 | 685 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 686 | # doxygen should invoke to get the current version for each file (typically from 687 | # the version control system). Doxygen will invoke the program by executing (via 688 | # popen()) the command command input-file, where command is the value of the 689 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 690 | # by doxygen. Whatever the program writes to standard output is used as the file 691 | # version. For an example see the documentation. 692 | 693 | FILE_VERSION_FILTER = 694 | 695 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 696 | # by doxygen. The layout file controls the global structure of the generated 697 | # output files in an output format independent way. To create the layout file 698 | # that represents doxygen's defaults, run doxygen with the -l option. You can 699 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 700 | # will be used as the name of the layout file. 701 | # 702 | # Note that if you run doxygen from a directory containing a file called 703 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 704 | # tag is left empty. 705 | 706 | LAYOUT_FILE = 707 | 708 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 709 | # the reference definitions. This must be a list of .bib files. The .bib 710 | # extension is automatically appended if omitted. This requires the bibtex tool 711 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 712 | # For LaTeX the style of the bibliography can be controlled using 713 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 714 | # search path. See also \cite for info how to create references. 715 | 716 | CITE_BIB_FILES = 717 | 718 | #--------------------------------------------------------------------------- 719 | # Configuration options related to warning and progress messages 720 | #--------------------------------------------------------------------------- 721 | 722 | # The QUIET tag can be used to turn on/off the messages that are generated to 723 | # standard output by doxygen. If QUIET is set to YES this implies that the 724 | # messages are off. 725 | # The default value is: NO. 726 | 727 | QUIET = NO 728 | 729 | # The WARNINGS tag can be used to turn on/off the warning messages that are 730 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 731 | # this implies that the warnings are on. 732 | # 733 | # Tip: Turn warnings on while writing the documentation. 734 | # The default value is: YES. 735 | 736 | WARNINGS = YES 737 | 738 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 739 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 740 | # will automatically be disabled. 741 | # The default value is: YES. 742 | 743 | WARN_IF_UNDOCUMENTED = YES 744 | 745 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 746 | # potential errors in the documentation, such as not documenting some parameters 747 | # in a documented function, or documenting parameters that don't exist or using 748 | # markup commands wrongly. 749 | # The default value is: YES. 750 | 751 | WARN_IF_DOC_ERROR = YES 752 | 753 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 754 | # are documented, but have no documentation for their parameters or return 755 | # value. If set to NO, doxygen will only warn about wrong or incomplete 756 | # parameter documentation, but not about the absence of documentation. 757 | # The default value is: NO. 758 | 759 | WARN_NO_PARAMDOC = NO 760 | 761 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 762 | # a warning is encountered. 763 | # The default value is: NO. 764 | 765 | WARN_AS_ERROR = NO 766 | 767 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 768 | # can produce. The string should contain the $file, $line, and $text tags, which 769 | # will be replaced by the file and line number from which the warning originated 770 | # and the warning text. Optionally the format may contain $version, which will 771 | # be replaced by the version of the file (if it could be obtained via 772 | # FILE_VERSION_FILTER) 773 | # The default value is: $file:$line: $text. 774 | 775 | WARN_FORMAT = "$file:$line: $text" 776 | 777 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 778 | # messages should be written. If left blank the output is written to standard 779 | # error (stderr). 780 | 781 | WARN_LOGFILE = 782 | 783 | #--------------------------------------------------------------------------- 784 | # Configuration options related to the input files 785 | #--------------------------------------------------------------------------- 786 | 787 | # The INPUT tag is used to specify the files and/or directories that contain 788 | # documented source files. You may enter file names like myfile.cpp or 789 | # directories like /usr/src/myproject. Separate the files or directories with 790 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 791 | # Note: If this tag is empty the current directory is searched. 792 | 793 | INPUT = 794 | 795 | # This tag can be used to specify the character encoding of the source files 796 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 797 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 798 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 799 | # possible encodings. 800 | # The default value is: UTF-8. 801 | 802 | INPUT_ENCODING = UTF-8 803 | 804 | # If the value of the INPUT tag contains directories, you can use the 805 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 806 | # *.h) to filter out the source-files in the directories. 807 | # 808 | # Note that for custom extensions or not directly supported extensions you also 809 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 810 | # read by doxygen. 811 | # 812 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 813 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 814 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 815 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 816 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 817 | 818 | FILE_PATTERNS = *.c \ 819 | *.cc \ 820 | *.cxx \ 821 | *.cpp \ 822 | *.c++ \ 823 | *.java \ 824 | *.ii \ 825 | *.ixx \ 826 | *.ipp \ 827 | *.i++ \ 828 | *.inl \ 829 | *.idl \ 830 | *.ddl \ 831 | *.odl \ 832 | *.h \ 833 | *.hh \ 834 | *.hxx \ 835 | *.hpp \ 836 | *.h++ \ 837 | *.cs \ 838 | *.d \ 839 | *.php \ 840 | *.php4 \ 841 | *.php5 \ 842 | *.phtml \ 843 | *.inc \ 844 | *.m \ 845 | *.markdown \ 846 | *.md \ 847 | *.mm \ 848 | *.dox \ 849 | *.py \ 850 | *.pyw \ 851 | *.f90 \ 852 | *.f95 \ 853 | *.f03 \ 854 | *.f08 \ 855 | *.f \ 856 | *.for \ 857 | *.tcl \ 858 | *.vhd \ 859 | *.vhdl \ 860 | *.ucf \ 861 | *.qsf 862 | 863 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 864 | # be searched for input files as well. 865 | # The default value is: NO. 866 | 867 | RECURSIVE = NO 868 | 869 | # The EXCLUDE tag can be used to specify files and/or directories that should be 870 | # excluded from the INPUT source files. This way you can easily exclude a 871 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 872 | # 873 | # Note that relative paths are relative to the directory from which doxygen is 874 | # run. 875 | 876 | EXCLUDE = 877 | 878 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 879 | # directories that are symbolic links (a Unix file system feature) are excluded 880 | # from the input. 881 | # The default value is: NO. 882 | 883 | EXCLUDE_SYMLINKS = NO 884 | 885 | # If the value of the INPUT tag contains directories, you can use the 886 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 887 | # certain files from those directories. 888 | # 889 | # Note that the wildcards are matched against the file with absolute path, so to 890 | # exclude all test directories for example use the pattern */test/* 891 | 892 | EXCLUDE_PATTERNS = 893 | 894 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 895 | # (namespaces, classes, functions, etc.) that should be excluded from the 896 | # output. The symbol name can be a fully qualified name, a word, or if the 897 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 898 | # AClass::ANamespace, ANamespace::*Test 899 | # 900 | # Note that the wildcards are matched against the file with absolute path, so to 901 | # exclude all test directories use the pattern */test/* 902 | 903 | EXCLUDE_SYMBOLS = 904 | 905 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 906 | # that contain example code fragments that are included (see the \include 907 | # command). 908 | 909 | EXAMPLE_PATH = 910 | 911 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 912 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 913 | # *.h) to filter out the source-files in the directories. If left blank all 914 | # files are included. 915 | 916 | EXAMPLE_PATTERNS = * 917 | 918 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 919 | # searched for input files to be used with the \include or \dontinclude commands 920 | # irrespective of the value of the RECURSIVE tag. 921 | # The default value is: NO. 922 | 923 | EXAMPLE_RECURSIVE = NO 924 | 925 | # The IMAGE_PATH tag can be used to specify one or more files or directories 926 | # that contain images that are to be included in the documentation (see the 927 | # \image command). 928 | 929 | IMAGE_PATH = 930 | 931 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 932 | # invoke to filter for each input file. Doxygen will invoke the filter program 933 | # by executing (via popen()) the command: 934 | # 935 | # 936 | # 937 | # where is the value of the INPUT_FILTER tag, and is the 938 | # name of an input file. Doxygen will then use the output that the filter 939 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 940 | # will be ignored. 941 | # 942 | # Note that the filter must not add or remove lines; it is applied before the 943 | # code is scanned, but not when the output code is generated. If lines are added 944 | # or removed, the anchors will not be placed correctly. 945 | # 946 | # Note that for custom extensions or not directly supported extensions you also 947 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 948 | # properly processed by doxygen. 949 | 950 | INPUT_FILTER = 951 | 952 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 953 | # basis. Doxygen will compare the file name with each pattern and apply the 954 | # filter if there is a match. The filters are a list of the form: pattern=filter 955 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 956 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 957 | # patterns match the file name, INPUT_FILTER is applied. 958 | # 959 | # Note that for custom extensions or not directly supported extensions you also 960 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 961 | # properly processed by doxygen. 962 | 963 | FILTER_PATTERNS = 964 | 965 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 966 | # INPUT_FILTER) will also be used to filter the input files that are used for 967 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 968 | # The default value is: NO. 969 | 970 | FILTER_SOURCE_FILES = NO 971 | 972 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 973 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 974 | # it is also possible to disable source filtering for a specific pattern using 975 | # *.ext= (so without naming a filter). 976 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 977 | 978 | FILTER_SOURCE_PATTERNS = 979 | 980 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 981 | # is part of the input, its contents will be placed on the main page 982 | # (index.html). This can be useful if you have a project on for instance GitHub 983 | # and want to reuse the introduction page also for the doxygen output. 984 | 985 | USE_MDFILE_AS_MAINPAGE = 986 | 987 | #--------------------------------------------------------------------------- 988 | # Configuration options related to source browsing 989 | #--------------------------------------------------------------------------- 990 | 991 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 992 | # generated. Documented entities will be cross-referenced with these sources. 993 | # 994 | # Note: To get rid of all source code in the generated output, make sure that 995 | # also VERBATIM_HEADERS is set to NO. 996 | # The default value is: NO. 997 | 998 | SOURCE_BROWSER = NO 999 | 1000 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1001 | # classes and enums directly into the documentation. 1002 | # The default value is: NO. 1003 | 1004 | INLINE_SOURCES = NO 1005 | 1006 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1007 | # special comment blocks from generated source code fragments. Normal C, C++ and 1008 | # Fortran comments will always remain visible. 1009 | # The default value is: YES. 1010 | 1011 | STRIP_CODE_COMMENTS = YES 1012 | 1013 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1014 | # function all documented functions referencing it will be listed. 1015 | # The default value is: NO. 1016 | 1017 | REFERENCED_BY_RELATION = NO 1018 | 1019 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1020 | # all documented entities called/used by that function will be listed. 1021 | # The default value is: NO. 1022 | 1023 | REFERENCES_RELATION = NO 1024 | 1025 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1026 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1027 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1028 | # link to the documentation. 1029 | # The default value is: YES. 1030 | 1031 | REFERENCES_LINK_SOURCE = YES 1032 | 1033 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1034 | # source code will show a tooltip with additional information such as prototype, 1035 | # brief description and links to the definition and documentation. Since this 1036 | # will make the HTML file larger and loading of large files a bit slower, you 1037 | # can opt to disable this feature. 1038 | # The default value is: YES. 1039 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1040 | 1041 | SOURCE_TOOLTIPS = YES 1042 | 1043 | # If the USE_HTAGS tag is set to YES then the references to source code will 1044 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1045 | # source browser. The htags tool is part of GNU's global source tagging system 1046 | # (see http://www.gnu.org/software/global/global.html). You will need version 1047 | # 4.8.6 or higher. 1048 | # 1049 | # To use it do the following: 1050 | # - Install the latest version of global 1051 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1052 | # - Make sure the INPUT points to the root of the source tree 1053 | # - Run doxygen as normal 1054 | # 1055 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1056 | # tools must be available from the command line (i.e. in the search path). 1057 | # 1058 | # The result: instead of the source browser generated by doxygen, the links to 1059 | # source code will now point to the output of htags. 1060 | # The default value is: NO. 1061 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1062 | 1063 | USE_HTAGS = NO 1064 | 1065 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1066 | # verbatim copy of the header file for each class for which an include is 1067 | # specified. Set to NO to disable this. 1068 | # See also: Section \class. 1069 | # The default value is: YES. 1070 | 1071 | VERBATIM_HEADERS = YES 1072 | 1073 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1074 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1075 | # cost of reduced performance. This can be particularly helpful with template 1076 | # rich C++ code for which doxygen's built-in parser lacks the necessary type 1077 | # information. 1078 | # Note: The availability of this option depends on whether or not doxygen was 1079 | # generated with the -Duse-libclang=ON option for CMake. 1080 | # The default value is: NO. 1081 | 1082 | CLANG_ASSISTED_PARSING = NO 1083 | 1084 | # If clang assisted parsing is enabled you can provide the compiler with command 1085 | # line options that you would normally use when invoking the compiler. Note that 1086 | # the include paths will already be set by doxygen for the files and directories 1087 | # specified with INPUT and INCLUDE_PATH. 1088 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1089 | 1090 | CLANG_OPTIONS = 1091 | 1092 | #--------------------------------------------------------------------------- 1093 | # Configuration options related to the alphabetical class index 1094 | #--------------------------------------------------------------------------- 1095 | 1096 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1097 | # compounds will be generated. Enable this if the project contains a lot of 1098 | # classes, structs, unions or interfaces. 1099 | # The default value is: YES. 1100 | 1101 | ALPHABETICAL_INDEX = YES 1102 | 1103 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1104 | # which the alphabetical index list will be split. 1105 | # Minimum value: 1, maximum value: 20, default value: 5. 1106 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1107 | 1108 | COLS_IN_ALPHA_INDEX = 5 1109 | 1110 | # In case all classes in a project start with a common prefix, all classes will 1111 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1112 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1113 | # while generating the index headers. 1114 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1115 | 1116 | IGNORE_PREFIX = 1117 | 1118 | #--------------------------------------------------------------------------- 1119 | # Configuration options related to the HTML output 1120 | #--------------------------------------------------------------------------- 1121 | 1122 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1123 | # The default value is: YES. 1124 | 1125 | GENERATE_HTML = YES 1126 | 1127 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1128 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1129 | # it. 1130 | # The default directory is: html. 1131 | # This tag requires that the tag GENERATE_HTML is set to YES. 1132 | 1133 | HTML_OUTPUT = html 1134 | 1135 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1136 | # generated HTML page (for example: .htm, .php, .asp). 1137 | # The default value is: .html. 1138 | # This tag requires that the tag GENERATE_HTML is set to YES. 1139 | 1140 | HTML_FILE_EXTENSION = .html 1141 | 1142 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1143 | # each generated HTML page. If the tag is left blank doxygen will generate a 1144 | # standard header. 1145 | # 1146 | # To get valid HTML the header file that includes any scripts and style sheets 1147 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1148 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1149 | # default header using 1150 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1151 | # YourConfigFile 1152 | # and then modify the file new_header.html. See also section "Doxygen usage" 1153 | # for information on how to generate the default header that doxygen normally 1154 | # uses. 1155 | # Note: The header is subject to change so you typically have to regenerate the 1156 | # default header when upgrading to a newer version of doxygen. For a description 1157 | # of the possible markers and block names see the documentation. 1158 | # This tag requires that the tag GENERATE_HTML is set to YES. 1159 | 1160 | HTML_HEADER = 1161 | 1162 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1163 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1164 | # footer. See HTML_HEADER for more information on how to generate a default 1165 | # footer and what special commands can be used inside the footer. See also 1166 | # section "Doxygen usage" for information on how to generate the default footer 1167 | # that doxygen normally uses. 1168 | # This tag requires that the tag GENERATE_HTML is set to YES. 1169 | 1170 | HTML_FOOTER = 1171 | 1172 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1173 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1174 | # the HTML output. If left blank doxygen will generate a default style sheet. 1175 | # See also section "Doxygen usage" for information on how to generate the style 1176 | # sheet that doxygen normally uses. 1177 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1178 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1179 | # obsolete. 1180 | # This tag requires that the tag GENERATE_HTML is set to YES. 1181 | 1182 | HTML_STYLESHEET = 1183 | 1184 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1185 | # cascading style sheets that are included after the standard style sheets 1186 | # created by doxygen. Using this option one can overrule certain style aspects. 1187 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1188 | # standard style sheet and is therefore more robust against future updates. 1189 | # Doxygen will copy the style sheet files to the output directory. 1190 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1191 | # style sheet in the list overrules the setting of the previous ones in the 1192 | # list). For an example see the documentation. 1193 | # This tag requires that the tag GENERATE_HTML is set to YES. 1194 | 1195 | HTML_EXTRA_STYLESHEET = 1196 | 1197 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1198 | # other source files which should be copied to the HTML output directory. Note 1199 | # that these files will be copied to the base HTML output directory. Use the 1200 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1201 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1202 | # files will be copied as-is; there are no commands or markers available. 1203 | # This tag requires that the tag GENERATE_HTML is set to YES. 1204 | 1205 | HTML_EXTRA_FILES = 1206 | 1207 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1208 | # will adjust the colors in the style sheet and background images according to 1209 | # this color. Hue is specified as an angle on a colorwheel, see 1210 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1211 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1212 | # purple, and 360 is red again. 1213 | # Minimum value: 0, maximum value: 359, default value: 220. 1214 | # This tag requires that the tag GENERATE_HTML is set to YES. 1215 | 1216 | HTML_COLORSTYLE_HUE = 220 1217 | 1218 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1219 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1220 | # value of 255 will produce the most vivid colors. 1221 | # Minimum value: 0, maximum value: 255, default value: 100. 1222 | # This tag requires that the tag GENERATE_HTML is set to YES. 1223 | 1224 | HTML_COLORSTYLE_SAT = 100 1225 | 1226 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1227 | # luminance component of the colors in the HTML output. Values below 100 1228 | # gradually make the output lighter, whereas values above 100 make the output 1229 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1230 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1231 | # change the gamma. 1232 | # Minimum value: 40, maximum value: 240, default value: 80. 1233 | # This tag requires that the tag GENERATE_HTML is set to YES. 1234 | 1235 | HTML_COLORSTYLE_GAMMA = 80 1236 | 1237 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1238 | # page will contain the date and time when the page was generated. Setting this 1239 | # to YES can help to show when doxygen was last run and thus if the 1240 | # documentation is up to date. 1241 | # The default value is: NO. 1242 | # This tag requires that the tag GENERATE_HTML is set to YES. 1243 | 1244 | HTML_TIMESTAMP = NO 1245 | 1246 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1247 | # documentation will contain sections that can be hidden and shown after the 1248 | # page has loaded. 1249 | # The default value is: NO. 1250 | # This tag requires that the tag GENERATE_HTML is set to YES. 1251 | 1252 | HTML_DYNAMIC_SECTIONS = NO 1253 | 1254 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1255 | # shown in the various tree structured indices initially; the user can expand 1256 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1257 | # such a level that at most the specified number of entries are visible (unless 1258 | # a fully collapsed tree already exceeds this amount). So setting the number of 1259 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1260 | # representing an infinite number of entries and will result in a full expanded 1261 | # tree by default. 1262 | # Minimum value: 0, maximum value: 9999, default value: 100. 1263 | # This tag requires that the tag GENERATE_HTML is set to YES. 1264 | 1265 | HTML_INDEX_NUM_ENTRIES = 100 1266 | 1267 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1268 | # generated that can be used as input for Apple's Xcode 3 integrated development 1269 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1270 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1271 | # Makefile in the HTML output directory. Running make will produce the docset in 1272 | # that directory and running make install will install the docset in 1273 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1274 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1275 | # for more information. 1276 | # The default value is: NO. 1277 | # This tag requires that the tag GENERATE_HTML is set to YES. 1278 | 1279 | GENERATE_DOCSET = NO 1280 | 1281 | # This tag determines the name of the docset feed. A documentation feed provides 1282 | # an umbrella under which multiple documentation sets from a single provider 1283 | # (such as a company or product suite) can be grouped. 1284 | # The default value is: Doxygen generated docs. 1285 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1286 | 1287 | DOCSET_FEEDNAME = "Doxygen generated docs" 1288 | 1289 | # This tag specifies a string that should uniquely identify the documentation 1290 | # set bundle. This should be a reverse domain-name style string, e.g. 1291 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1292 | # The default value is: org.doxygen.Project. 1293 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1294 | 1295 | DOCSET_BUNDLE_ID = org.doxygen.Project 1296 | 1297 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1298 | # the documentation publisher. This should be a reverse domain-name style 1299 | # string, e.g. com.mycompany.MyDocSet.documentation. 1300 | # The default value is: org.doxygen.Publisher. 1301 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1302 | 1303 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1304 | 1305 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1306 | # The default value is: Publisher. 1307 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1308 | 1309 | DOCSET_PUBLISHER_NAME = Publisher 1310 | 1311 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1312 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1313 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1314 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1315 | # Windows. 1316 | # 1317 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1318 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1319 | # files are now used as the Windows 98 help format, and will replace the old 1320 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1321 | # HTML files also contain an index, a table of contents, and you can search for 1322 | # words in the documentation. The HTML workshop also contains a viewer for 1323 | # compressed HTML files. 1324 | # The default value is: NO. 1325 | # This tag requires that the tag GENERATE_HTML is set to YES. 1326 | 1327 | GENERATE_HTMLHELP = NO 1328 | 1329 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1330 | # file. You can add a path in front of the file if the result should not be 1331 | # written to the html output directory. 1332 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1333 | 1334 | CHM_FILE = 1335 | 1336 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1337 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1338 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1339 | # The file has to be specified with full path. 1340 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1341 | 1342 | HHC_LOCATION = 1343 | 1344 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1345 | # (YES) or that it should be included in the master .chm file (NO). 1346 | # The default value is: NO. 1347 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1348 | 1349 | GENERATE_CHI = NO 1350 | 1351 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1352 | # and project file content. 1353 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1354 | 1355 | CHM_INDEX_ENCODING = 1356 | 1357 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1358 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1359 | # enables the Previous and Next buttons. 1360 | # The default value is: NO. 1361 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1362 | 1363 | BINARY_TOC = NO 1364 | 1365 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1366 | # the table of contents of the HTML help documentation and to the tree view. 1367 | # The default value is: NO. 1368 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1369 | 1370 | TOC_EXPAND = NO 1371 | 1372 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1373 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1374 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1375 | # (.qch) of the generated HTML documentation. 1376 | # The default value is: NO. 1377 | # This tag requires that the tag GENERATE_HTML is set to YES. 1378 | 1379 | GENERATE_QHP = NO 1380 | 1381 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1382 | # the file name of the resulting .qch file. The path specified is relative to 1383 | # the HTML output folder. 1384 | # This tag requires that the tag GENERATE_QHP is set to YES. 1385 | 1386 | QCH_FILE = 1387 | 1388 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1389 | # Project output. For more information please see Qt Help Project / Namespace 1390 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1391 | # The default value is: org.doxygen.Project. 1392 | # This tag requires that the tag GENERATE_QHP is set to YES. 1393 | 1394 | QHP_NAMESPACE = org.doxygen.Project 1395 | 1396 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1397 | # Help Project output. For more information please see Qt Help Project / Virtual 1398 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1399 | # folders). 1400 | # The default value is: doc. 1401 | # This tag requires that the tag GENERATE_QHP is set to YES. 1402 | 1403 | QHP_VIRTUAL_FOLDER = doc 1404 | 1405 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1406 | # filter to add. For more information please see Qt Help Project / Custom 1407 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1408 | # filters). 1409 | # This tag requires that the tag GENERATE_QHP is set to YES. 1410 | 1411 | QHP_CUST_FILTER_NAME = 1412 | 1413 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1414 | # custom filter to add. For more information please see Qt Help Project / Custom 1415 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1416 | # filters). 1417 | # This tag requires that the tag GENERATE_QHP is set to YES. 1418 | 1419 | QHP_CUST_FILTER_ATTRS = 1420 | 1421 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1422 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1423 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1424 | # This tag requires that the tag GENERATE_QHP is set to YES. 1425 | 1426 | QHP_SECT_FILTER_ATTRS = 1427 | 1428 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1429 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1430 | # generated .qhp file. 1431 | # This tag requires that the tag GENERATE_QHP is set to YES. 1432 | 1433 | QHG_LOCATION = 1434 | 1435 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1436 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1437 | # install this plugin and make it available under the help contents menu in 1438 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1439 | # to be copied into the plugins directory of eclipse. The name of the directory 1440 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1441 | # After copying Eclipse needs to be restarted before the help appears. 1442 | # The default value is: NO. 1443 | # This tag requires that the tag GENERATE_HTML is set to YES. 1444 | 1445 | GENERATE_ECLIPSEHELP = NO 1446 | 1447 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1448 | # the directory name containing the HTML and XML files should also have this 1449 | # name. Each documentation set should have its own identifier. 1450 | # The default value is: org.doxygen.Project. 1451 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1452 | 1453 | ECLIPSE_DOC_ID = org.doxygen.Project 1454 | 1455 | # If you want full control over the layout of the generated HTML pages it might 1456 | # be necessary to disable the index and replace it with your own. The 1457 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1458 | # of each HTML page. A value of NO enables the index and the value YES disables 1459 | # it. Since the tabs in the index contain the same information as the navigation 1460 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1461 | # The default value is: NO. 1462 | # This tag requires that the tag GENERATE_HTML is set to YES. 1463 | 1464 | DISABLE_INDEX = NO 1465 | 1466 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1467 | # structure should be generated to display hierarchical information. If the tag 1468 | # value is set to YES, a side panel will be generated containing a tree-like 1469 | # index structure (just like the one that is generated for HTML Help). For this 1470 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1471 | # (i.e. any modern browser). Windows users are probably better off using the 1472 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1473 | # further fine-tune the look of the index. As an example, the default style 1474 | # sheet generated by doxygen has an example that shows how to put an image at 1475 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1476 | # the same information as the tab index, you could consider setting 1477 | # DISABLE_INDEX to YES when enabling this option. 1478 | # The default value is: NO. 1479 | # This tag requires that the tag GENERATE_HTML is set to YES. 1480 | 1481 | GENERATE_TREEVIEW = NO 1482 | 1483 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1484 | # doxygen will group on one line in the generated HTML documentation. 1485 | # 1486 | # Note that a value of 0 will completely suppress the enum values from appearing 1487 | # in the overview section. 1488 | # Minimum value: 0, maximum value: 20, default value: 4. 1489 | # This tag requires that the tag GENERATE_HTML is set to YES. 1490 | 1491 | ENUM_VALUES_PER_LINE = 4 1492 | 1493 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1494 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1495 | # Minimum value: 0, maximum value: 1500, default value: 250. 1496 | # This tag requires that the tag GENERATE_HTML is set to YES. 1497 | 1498 | TREEVIEW_WIDTH = 250 1499 | 1500 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1501 | # external symbols imported via tag files in a separate window. 1502 | # The default value is: NO. 1503 | # This tag requires that the tag GENERATE_HTML is set to YES. 1504 | 1505 | EXT_LINKS_IN_WINDOW = NO 1506 | 1507 | # Use this tag to change the font size of LaTeX formulas included as images in 1508 | # the HTML documentation. When you change the font size after a successful 1509 | # doxygen run you need to manually remove any form_*.png images from the HTML 1510 | # output directory to force them to be regenerated. 1511 | # Minimum value: 8, maximum value: 50, default value: 10. 1512 | # This tag requires that the tag GENERATE_HTML is set to YES. 1513 | 1514 | FORMULA_FONTSIZE = 10 1515 | 1516 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1517 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1518 | # supported properly for IE 6.0, but are supported on all modern browsers. 1519 | # 1520 | # Note that when changing this option you need to delete any form_*.png files in 1521 | # the HTML output directory before the changes have effect. 1522 | # The default value is: YES. 1523 | # This tag requires that the tag GENERATE_HTML is set to YES. 1524 | 1525 | FORMULA_TRANSPARENT = YES 1526 | 1527 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1528 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1529 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1530 | # installed or if you want to formulas look prettier in the HTML output. When 1531 | # enabled you may also need to install MathJax separately and configure the path 1532 | # to it using the MATHJAX_RELPATH option. 1533 | # The default value is: NO. 1534 | # This tag requires that the tag GENERATE_HTML is set to YES. 1535 | 1536 | USE_MATHJAX = NO 1537 | 1538 | # When MathJax is enabled you can set the default output format to be used for 1539 | # the MathJax output. See the MathJax site (see: 1540 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1541 | # Possible values are: HTML-CSS (which is slower, but has the best 1542 | # compatibility), NativeMML (i.e. MathML) and SVG. 1543 | # The default value is: HTML-CSS. 1544 | # This tag requires that the tag USE_MATHJAX is set to YES. 1545 | 1546 | MATHJAX_FORMAT = HTML-CSS 1547 | 1548 | # When MathJax is enabled you need to specify the location relative to the HTML 1549 | # output directory using the MATHJAX_RELPATH option. The destination directory 1550 | # should contain the MathJax.js script. For instance, if the mathjax directory 1551 | # is located at the same level as the HTML output directory, then 1552 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1553 | # Content Delivery Network so you can quickly see the result without installing 1554 | # MathJax. However, it is strongly recommended to install a local copy of 1555 | # MathJax from http://www.mathjax.org before deployment. 1556 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1557 | # This tag requires that the tag USE_MATHJAX is set to YES. 1558 | 1559 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1560 | 1561 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1562 | # extension names that should be enabled during MathJax rendering. For example 1563 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1564 | # This tag requires that the tag USE_MATHJAX is set to YES. 1565 | 1566 | MATHJAX_EXTENSIONS = 1567 | 1568 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1569 | # of code that will be used on startup of the MathJax code. See the MathJax site 1570 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1571 | # example see the documentation. 1572 | # This tag requires that the tag USE_MATHJAX is set to YES. 1573 | 1574 | MATHJAX_CODEFILE = 1575 | 1576 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1577 | # the HTML output. The underlying search engine uses javascript and DHTML and 1578 | # should work on any modern browser. Note that when using HTML help 1579 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1580 | # there is already a search function so this one should typically be disabled. 1581 | # For large projects the javascript based search engine can be slow, then 1582 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1583 | # search using the keyboard; to jump to the search box use + S 1584 | # (what the is depends on the OS and browser, but it is typically 1585 | # , /