├── .gitignore ├── .travis.yml ├── Doxyfile ├── LICENSE ├── Makefile ├── README.md ├── configure ├── runtests.py ├── src ├── Cipher.c ├── Cipher.h ├── CryptImpHook.c ├── CryptImpHook.h └── CryptImpHook_Conv.c ├── test_script.py └── test_script_b.py /.gitignore: -------------------------------------------------------------------------------- 1 | docs/* 2 | dist 3 | *.o 4 | *pye 5 | valgrind-python.supp 6 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: c 2 | -------------------------------------------------------------------------------- /Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.7.2 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 hash (#) is considered a comment and will be ignored. 7 | # The format is: 8 | # TAG = value [value, ...] 9 | # For lists items can also be appended using: 10 | # TAG += value [value, ...] 11 | # Values that contain spaces should be placed between quotes (" "). 12 | 13 | #--------------------------------------------------------------------------- 14 | # Project related configuration options 15 | #--------------------------------------------------------------------------- 16 | 17 | # This tag specifies the encoding used for all characters in the config file 18 | # that follow. The default is UTF-8 which is also the encoding used for all 19 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the 20 | # iconv built into libc) for the transcoding. See 21 | # http://www.gnu.org/software/libiconv for the list of possible encodings. 22 | 23 | DOXYFILE_ENCODING = UTF-8 24 | 25 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 26 | # by quotes) that should identify the project. 27 | 28 | PROJECT_NAME = CryptImpHook 29 | 30 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. 31 | # This could be handy for archiving the generated documentation or 32 | # if some version control system is used. 33 | 34 | PROJECT_NUMBER = 1.0 35 | 36 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 37 | # base path where the generated documentation will be put. 38 | # If a relative path is entered, it will be relative to the location 39 | # where doxygen was started. If left blank the current directory will be used. 40 | 41 | OUTPUT_DIRECTORY = docs 42 | 43 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 44 | # 4096 sub-directories (in 2 levels) under the output directory of each output 45 | # format and will distribute the generated files over these directories. 46 | # Enabling this option can be useful when feeding doxygen a huge amount of 47 | # source files, where putting all generated files in the same directory would 48 | # otherwise cause performance problems for the file system. 49 | 50 | CREATE_SUBDIRS = NO 51 | 52 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 53 | # documentation generated by doxygen is written. Doxygen will use this 54 | # information to generate all constant output in the proper language. 55 | # The default language is English, other supported languages are: 56 | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 57 | # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 58 | # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 59 | # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 60 | # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, 61 | # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 62 | 63 | OUTPUT_LANGUAGE = English 64 | 65 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 66 | # include brief member descriptions after the members that are listed in 67 | # the file and class documentation (similar to JavaDoc). 68 | # Set to NO to disable this. 69 | 70 | BRIEF_MEMBER_DESC = YES 71 | 72 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 73 | # the brief description of a member or function before the detailed description. 74 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 75 | # brief descriptions will be completely suppressed. 76 | 77 | REPEAT_BRIEF = YES 78 | 79 | # This tag implements a quasi-intelligent brief description abbreviator 80 | # that is used to form the text in various listings. Each string 81 | # in this list, if found as the leading text of the brief description, will be 82 | # stripped from the text and the result after processing the whole list, is 83 | # used as the annotated text. Otherwise, the brief description is used as-is. 84 | # If left blank, the following values are used ("$name" is automatically 85 | # replaced with the name of the entity): "The $name class" "The $name widget" 86 | # "The $name file" "is" "provides" "specifies" "contains" 87 | # "represents" "a" "an" "the" 88 | 89 | ABBREVIATE_BRIEF = 90 | 91 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 92 | # Doxygen will generate a detailed section even if there is only a brief 93 | # description. 94 | 95 | ALWAYS_DETAILED_SEC = NO 96 | 97 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 98 | # inherited members of a class in the documentation of that class as if those 99 | # members were ordinary class members. Constructors, destructors and assignment 100 | # operators of the base classes will not be shown. 101 | 102 | INLINE_INHERITED_MEMB = NO 103 | 104 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 105 | # path before files name in the file list and in the header files. If set 106 | # to NO the shortest path that makes the file name unique will be used. 107 | 108 | FULL_PATH_NAMES = YES 109 | 110 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 111 | # can be used to strip a user-defined part of the path. Stripping is 112 | # only done if one of the specified strings matches the left-hand part of 113 | # the path. The tag can be used to show relative paths in the file list. 114 | # If left blank the directory from which doxygen is run is used as the 115 | # path to strip. 116 | 117 | STRIP_FROM_PATH = 118 | 119 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 120 | # the path mentioned in the documentation of a class, which tells 121 | # the reader which header file to include in order to use a class. 122 | # If left blank only the name of the header file containing the class 123 | # definition is used. Otherwise one should specify the include paths that 124 | # are normally passed to the compiler using the -I flag. 125 | 126 | STRIP_FROM_INC_PATH = 127 | 128 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 129 | # (but less readable) file names. This can be useful if your file system 130 | # doesn't support long names like on DOS, Mac, or CD-ROM. 131 | 132 | SHORT_NAMES = NO 133 | 134 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 135 | # will interpret the first line (until the first dot) of a JavaDoc-style 136 | # comment as the brief description. If set to NO, the JavaDoc 137 | # comments will behave just like regular Qt-style comments 138 | # (thus requiring an explicit @brief command for a brief description.) 139 | 140 | JAVADOC_AUTOBRIEF = NO 141 | 142 | # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 143 | # interpret the first line (until the first dot) of a Qt-style 144 | # comment as the brief description. If set to NO, the comments 145 | # will behave just like regular Qt-style comments (thus requiring 146 | # an explicit \brief command for a brief description.) 147 | 148 | QT_AUTOBRIEF = NO 149 | 150 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 151 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// 152 | # comments) as a brief description. This used to be the default behaviour. 153 | # The new default is to treat a multi-line C++ comment block as a detailed 154 | # description. Set this tag to YES if you prefer the old behaviour instead. 155 | 156 | MULTILINE_CPP_IS_BRIEF = NO 157 | 158 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 159 | # member inherits the documentation from any documented member that it 160 | # re-implements. 161 | 162 | INHERIT_DOCS = YES 163 | 164 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 165 | # a new page for each member. If set to NO, the documentation of a member will 166 | # be part of the file/class/namespace that contains it. 167 | 168 | SEPARATE_MEMBER_PAGES = NO 169 | 170 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. 171 | # Doxygen uses this value to replace tabs by spaces in code fragments. 172 | 173 | TAB_SIZE = 8 174 | 175 | # This tag can be used to specify a number of aliases that acts 176 | # as commands in the documentation. An alias has the form "name=value". 177 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to 178 | # put the command \sideeffect (or @sideeffect) in the documentation, which 179 | # will result in a user-defined paragraph with heading "Side Effects:". 180 | # You can put \n's in the value part of an alias to insert newlines. 181 | 182 | ALIASES = 183 | 184 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 185 | # sources only. Doxygen will then generate output that is more tailored for C. 186 | # For instance, some of the names that are used will be different. The list 187 | # of all members will be omitted, etc. 188 | 189 | OPTIMIZE_OUTPUT_FOR_C = YES 190 | 191 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 192 | # sources only. Doxygen will then generate output that is more tailored for 193 | # Java. For instance, namespaces will be presented as packages, qualified 194 | # scopes will look different, etc. 195 | 196 | OPTIMIZE_OUTPUT_JAVA = NO 197 | 198 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 199 | # sources only. Doxygen will then generate output that is more tailored for 200 | # Fortran. 201 | 202 | OPTIMIZE_FOR_FORTRAN = NO 203 | 204 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 205 | # sources. Doxygen will then generate output that is tailored for 206 | # VHDL. 207 | 208 | OPTIMIZE_OUTPUT_VHDL = NO 209 | 210 | # Doxygen selects the parser to use depending on the extension of the files it 211 | # parses. With this tag you can assign which parser to use for a given extension. 212 | # Doxygen has a built-in mapping, but you can override or extend it using this 213 | # tag. The format is ext=language, where ext is a file extension, and language 214 | # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 215 | # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 216 | # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 217 | # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 218 | # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 219 | 220 | EXTENSION_MAPPING = 221 | 222 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 223 | # to include (a tag file for) the STL sources as input, then you should 224 | # set this tag to YES in order to let doxygen match functions declarations and 225 | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 226 | # func(std::string) {}). This also makes the inheritance and collaboration 227 | # diagrams that involve STL classes more complete and accurate. 228 | 229 | BUILTIN_STL_SUPPORT = NO 230 | 231 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 232 | # enable parsing support. 233 | 234 | CPP_CLI_SUPPORT = NO 235 | 236 | # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 237 | # Doxygen will parse them like normal C++ but will assume all classes use public 238 | # instead of private inheritance when no explicit protection keyword is present. 239 | 240 | SIP_SUPPORT = NO 241 | 242 | # For Microsoft's IDL there are propget and propput attributes to indicate getter 243 | # and setter methods for a property. Setting this option to YES (the default) 244 | # will make doxygen replace the get and set methods by a property in the 245 | # documentation. This will only work if the methods are indeed getting or 246 | # setting a simple type. If this is not the case, or you want to show the 247 | # methods anyway, you should set this option to NO. 248 | 249 | IDL_PROPERTY_SUPPORT = YES 250 | 251 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 252 | # tag is set to YES, then doxygen will reuse the documentation of the first 253 | # member in the group (if any) for the other members of the group. By default 254 | # all members of a group must be documented explicitly. 255 | 256 | DISTRIBUTE_GROUP_DOC = NO 257 | 258 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 259 | # the same type (for instance a group of public functions) to be put as a 260 | # subgroup of that type (e.g. under the Public Functions section). Set it to 261 | # NO to prevent subgrouping. Alternatively, this can be done per class using 262 | # the \nosubgrouping command. 263 | 264 | SUBGROUPING = YES 265 | 266 | # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 267 | # is documented as struct, union, or enum with the name of the typedef. So 268 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 269 | # with name TypeT. When disabled the typedef will appear as a member of a file, 270 | # namespace, or class. And the struct will be named TypeS. This can typically 271 | # be useful for C code in case the coding convention dictates that all compound 272 | # types are typedef'ed and only the typedef is referenced, never the tag name. 273 | 274 | TYPEDEF_HIDES_STRUCT = NO 275 | 276 | # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 277 | # determine which symbols to keep in memory and which to flush to disk. 278 | # When the cache is full, less often used symbols will be written to disk. 279 | # For small to medium size projects (<1000 input files) the default value is 280 | # probably good enough. For larger projects a too small cache size can cause 281 | # doxygen to be busy swapping symbols to and from disk most of the time 282 | # causing a significant performance penality. 283 | # If the system has enough physical memory increasing the cache will improve the 284 | # performance by keeping more symbols in memory. Note that the value works on 285 | # a logarithmic scale so increasing the size by one will roughly double the 286 | # memory usage. The cache size is given by this formula: 287 | # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 288 | # corresponding to a cache size of 2^16 = 65536 symbols 289 | 290 | SYMBOL_CACHE_SIZE = 0 291 | 292 | #--------------------------------------------------------------------------- 293 | # Build related configuration options 294 | #--------------------------------------------------------------------------- 295 | 296 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 297 | # documentation are documented, even if no documentation was available. 298 | # Private class members and static file members will be hidden unless 299 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 300 | 301 | EXTRACT_ALL = YES 302 | 303 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 304 | # will be included in the documentation. 305 | 306 | EXTRACT_PRIVATE = NO 307 | 308 | # If the EXTRACT_STATIC tag is set to YES all static members of a file 309 | # will be included in the documentation. 310 | 311 | EXTRACT_STATIC = NO 312 | 313 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 314 | # defined locally in source files will be included in the documentation. 315 | # If set to NO only classes defined in header files are included. 316 | 317 | EXTRACT_LOCAL_CLASSES = YES 318 | 319 | # This flag is only useful for Objective-C code. When set to YES local 320 | # methods, which are defined in the implementation section but not in 321 | # the interface are included in the documentation. 322 | # If set to NO (the default) only methods in the interface are included. 323 | 324 | EXTRACT_LOCAL_METHODS = NO 325 | 326 | # If this flag is set to YES, the members of anonymous namespaces will be 327 | # extracted and appear in the documentation as a namespace called 328 | # 'anonymous_namespace{file}', where file will be replaced with the base 329 | # name of the file that contains the anonymous namespace. By default 330 | # anonymous namespaces are hidden. 331 | 332 | EXTRACT_ANON_NSPACES = NO 333 | 334 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 335 | # undocumented members of documented classes, files or namespaces. 336 | # If set to NO (the default) these members will be included in the 337 | # various overviews, but no documentation section is generated. 338 | # This option has no effect if EXTRACT_ALL is enabled. 339 | 340 | HIDE_UNDOC_MEMBERS = NO 341 | 342 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 343 | # undocumented classes that are normally visible in the class hierarchy. 344 | # If set to NO (the default) these classes will be included in the various 345 | # overviews. This option has no effect if EXTRACT_ALL is enabled. 346 | 347 | HIDE_UNDOC_CLASSES = NO 348 | 349 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 350 | # friend (class|struct|union) declarations. 351 | # If set to NO (the default) these declarations will be included in the 352 | # documentation. 353 | 354 | HIDE_FRIEND_COMPOUNDS = NO 355 | 356 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 357 | # documentation blocks found inside the body of a function. 358 | # If set to NO (the default) these blocks will be appended to the 359 | # function's detailed documentation block. 360 | 361 | HIDE_IN_BODY_DOCS = NO 362 | 363 | # The INTERNAL_DOCS tag determines if documentation 364 | # that is typed after a \internal command is included. If the tag is set 365 | # to NO (the default) then the documentation will be excluded. 366 | # Set it to YES to include the internal documentation. 367 | 368 | INTERNAL_DOCS = NO 369 | 370 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 371 | # file names in lower-case letters. If set to YES upper-case letters are also 372 | # allowed. This is useful if you have classes or files whose names only differ 373 | # in case and if your file system supports case sensitive file names. Windows 374 | # and Mac users are advised to set this option to NO. 375 | 376 | CASE_SENSE_NAMES = YES 377 | 378 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 379 | # will show members with their full class and namespace scopes in the 380 | # documentation. If set to YES the scope will be hidden. 381 | 382 | HIDE_SCOPE_NAMES = NO 383 | 384 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 385 | # will put a list of the files that are included by a file in the documentation 386 | # of that file. 387 | 388 | SHOW_INCLUDE_FILES = YES 389 | 390 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 391 | # will list include files with double quotes in the documentation 392 | # rather than with sharp brackets. 393 | 394 | FORCE_LOCAL_INCLUDES = NO 395 | 396 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 397 | # is inserted in the documentation for inline members. 398 | 399 | INLINE_INFO = YES 400 | 401 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 402 | # will sort the (detailed) documentation of file and class members 403 | # alphabetically by member name. If set to NO the members will appear in 404 | # declaration order. 405 | 406 | SORT_MEMBER_DOCS = YES 407 | 408 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 409 | # brief documentation of file, namespace and class members alphabetically 410 | # by member name. If set to NO (the default) the members will appear in 411 | # declaration order. 412 | 413 | SORT_BRIEF_DOCS = NO 414 | 415 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 416 | # will sort the (brief and detailed) documentation of class members so that 417 | # constructors and destructors are listed first. If set to NO (the default) 418 | # the constructors will appear in the respective orders defined by 419 | # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 420 | # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 421 | # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 422 | 423 | SORT_MEMBERS_CTORS_1ST = NO 424 | 425 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 426 | # hierarchy of group names into alphabetical order. If set to NO (the default) 427 | # the group names will appear in their defined order. 428 | 429 | SORT_GROUP_NAMES = NO 430 | 431 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 432 | # sorted by fully-qualified names, including namespaces. If set to 433 | # NO (the default), the class list will be sorted only by class name, 434 | # not including the namespace part. 435 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 436 | # Note: This option applies only to the class list, not to the 437 | # alphabetical list. 438 | 439 | SORT_BY_SCOPE_NAME = NO 440 | 441 | # The GENERATE_TODOLIST tag can be used to enable (YES) or 442 | # disable (NO) the todo list. This list is created by putting \todo 443 | # commands in the documentation. 444 | 445 | GENERATE_TODOLIST = YES 446 | 447 | # The GENERATE_TESTLIST tag can be used to enable (YES) or 448 | # disable (NO) the test list. This list is created by putting \test 449 | # commands in the documentation. 450 | 451 | GENERATE_TESTLIST = YES 452 | 453 | # The GENERATE_BUGLIST tag can be used to enable (YES) or 454 | # disable (NO) the bug list. This list is created by putting \bug 455 | # commands in the documentation. 456 | 457 | GENERATE_BUGLIST = YES 458 | 459 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 460 | # disable (NO) the deprecated list. This list is created by putting 461 | # \deprecated commands in the documentation. 462 | 463 | GENERATE_DEPRECATEDLIST= YES 464 | 465 | # The ENABLED_SECTIONS tag can be used to enable conditional 466 | # documentation sections, marked by \if sectionname ... \endif. 467 | 468 | ENABLED_SECTIONS = 469 | 470 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 471 | # the initial value of a variable or macro consists of for it to appear in 472 | # the documentation. If the initializer consists of more lines than specified 473 | # here it will be hidden. Use a value of 0 to hide initializers completely. 474 | # The appearance of the initializer of individual variables and macros in the 475 | # documentation can be controlled using \showinitializer or \hideinitializer 476 | # command in the documentation regardless of this setting. 477 | 478 | MAX_INITIALIZER_LINES = 30 479 | 480 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 481 | # at the bottom of the documentation of classes and structs. If set to YES the 482 | # list will mention the files that were used to generate the documentation. 483 | 484 | SHOW_USED_FILES = YES 485 | 486 | # If the sources in your project are distributed over multiple directories 487 | # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 488 | # in the documentation. The default is NO. 489 | 490 | SHOW_DIRECTORIES = NO 491 | 492 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 493 | # This will remove the Files entry from the Quick Index and from the 494 | # Folder Tree View (if specified). The default is YES. 495 | 496 | SHOW_FILES = YES 497 | 498 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 499 | # Namespaces page. 500 | # This will remove the Namespaces entry from the Quick Index 501 | # and from the Folder Tree View (if specified). The default is YES. 502 | 503 | SHOW_NAMESPACES = YES 504 | 505 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 506 | # doxygen should invoke to get the current version for each file (typically from 507 | # the version control system). Doxygen will invoke the program by executing (via 508 | # popen()) the command , where is the value of 509 | # the FILE_VERSION_FILTER tag, and is the name of an input file 510 | # provided by doxygen. Whatever the program writes to standard output 511 | # is used as the file version. See the manual for examples. 512 | 513 | FILE_VERSION_FILTER = 514 | 515 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 516 | # by doxygen. The layout file controls the global structure of the generated 517 | # output files in an output format independent way. The create the layout file 518 | # that represents doxygen's defaults, run doxygen with the -l option. 519 | # You can optionally specify a file name after the option, if omitted 520 | # DoxygenLayout.xml will be used as the name of the layout file. 521 | 522 | LAYOUT_FILE = 523 | 524 | #--------------------------------------------------------------------------- 525 | # configuration options related to warning and progress messages 526 | #--------------------------------------------------------------------------- 527 | 528 | # The QUIET tag can be used to turn on/off the messages that are generated 529 | # by doxygen. Possible values are YES and NO. If left blank NO is used. 530 | 531 | QUIET = NO 532 | 533 | # The WARNINGS tag can be used to turn on/off the warning messages that are 534 | # generated by doxygen. Possible values are YES and NO. If left blank 535 | # NO is used. 536 | 537 | WARNINGS = YES 538 | 539 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 540 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 541 | # automatically be disabled. 542 | 543 | WARN_IF_UNDOCUMENTED = YES 544 | 545 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 546 | # potential errors in the documentation, such as not documenting some 547 | # parameters in a documented function, or documenting parameters that 548 | # don't exist or using markup commands wrongly. 549 | 550 | WARN_IF_DOC_ERROR = YES 551 | 552 | # The WARN_NO_PARAMDOC option can be enabled to get warnings for 553 | # functions that are documented, but have no documentation for their parameters 554 | # or return value. If set to NO (the default) doxygen will only warn about 555 | # wrong or incomplete parameter documentation, but not about the absence of 556 | # documentation. 557 | 558 | WARN_NO_PARAMDOC = NO 559 | 560 | # The WARN_FORMAT tag determines the format of the warning messages that 561 | # doxygen can produce. The string should contain the $file, $line, and $text 562 | # tags, which will be replaced by the file and line number from which the 563 | # warning originated and the warning text. Optionally the format may contain 564 | # $version, which will be replaced by the version of the file (if it could 565 | # be obtained via FILE_VERSION_FILTER) 566 | 567 | WARN_FORMAT = "$file:$line: $text" 568 | 569 | # The WARN_LOGFILE tag can be used to specify a file to which warning 570 | # and error messages should be written. If left blank the output is written 571 | # to stderr. 572 | 573 | WARN_LOGFILE = 574 | 575 | #--------------------------------------------------------------------------- 576 | # configuration options related to the input files 577 | #--------------------------------------------------------------------------- 578 | 579 | # The INPUT tag can be used to specify the files and/or directories that contain 580 | # documented source files. You may enter file names like "myfile.cpp" or 581 | # directories like "/usr/src/myproject". Separate the files or directories 582 | # with spaces. 583 | 584 | INPUT = src 585 | 586 | # This tag can be used to specify the character encoding of the source files 587 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 588 | # also the default input encoding. Doxygen uses libiconv (or the iconv built 589 | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 590 | # the list of possible encodings. 591 | 592 | INPUT_ENCODING = UTF-8 593 | 594 | # If the value of the INPUT tag contains directories, you can use the 595 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 596 | # and *.h) to filter out the source-files in the directories. If left 597 | # blank the following patterns are tested: 598 | # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 599 | # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 600 | # *.f90 *.f *.vhd *.vhdl 601 | 602 | FILE_PATTERNS = 603 | 604 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories 605 | # should be searched for input files as well. Possible values are YES and NO. 606 | # If left blank NO is used. 607 | 608 | RECURSIVE = NO 609 | 610 | # The EXCLUDE tag can be used to specify files and/or directories that should 611 | # excluded from the INPUT source files. This way you can easily exclude a 612 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 613 | 614 | EXCLUDE = 615 | 616 | # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 617 | # directories that are symbolic links (a Unix filesystem feature) are excluded 618 | # from the input. 619 | 620 | EXCLUDE_SYMLINKS = NO 621 | 622 | # If the value of the INPUT tag contains directories, you can use the 623 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 624 | # certain files from those directories. Note that the wildcards are matched 625 | # against the file with absolute path, so to exclude all test directories 626 | # for example use the pattern */test/* 627 | 628 | EXCLUDE_PATTERNS = 629 | 630 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 631 | # (namespaces, classes, functions, etc.) that should be excluded from the 632 | # output. The symbol name can be a fully qualified name, a word, or if the 633 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 634 | # AClass::ANamespace, ANamespace::*Test 635 | 636 | EXCLUDE_SYMBOLS = 637 | 638 | # The EXAMPLE_PATH tag can be used to specify one or more files or 639 | # directories that contain example code fragments that are included (see 640 | # the \include command). 641 | 642 | EXAMPLE_PATH = 643 | 644 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 645 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 646 | # and *.h) to filter out the source-files in the directories. If left 647 | # blank all files are included. 648 | 649 | EXAMPLE_PATTERNS = 650 | 651 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 652 | # searched for input files to be used with the \include or \dontinclude 653 | # commands irrespective of the value of the RECURSIVE tag. 654 | # Possible values are YES and NO. If left blank NO is used. 655 | 656 | EXAMPLE_RECURSIVE = NO 657 | 658 | # The IMAGE_PATH tag can be used to specify one or more files or 659 | # directories that contain image that are included in the documentation (see 660 | # the \image command). 661 | 662 | IMAGE_PATH = 663 | 664 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 665 | # invoke to filter for each input file. Doxygen will invoke the filter program 666 | # by executing (via popen()) the command , where 667 | # is the value of the INPUT_FILTER tag, and is the name of an 668 | # input file. Doxygen will then use the output that the filter program writes 669 | # to standard output. 670 | # If FILTER_PATTERNS is specified, this tag will be 671 | # ignored. 672 | 673 | INPUT_FILTER = 674 | 675 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 676 | # basis. 677 | # Doxygen will compare the file name with each pattern and apply the 678 | # filter if there is a match. 679 | # The filters are a list of the form: 680 | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 681 | # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 682 | # is applied to all files. 683 | 684 | FILTER_PATTERNS = 685 | 686 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 687 | # INPUT_FILTER) will be used to filter the input files when producing source 688 | # files to browse (i.e. when SOURCE_BROWSER is set to YES). 689 | 690 | FILTER_SOURCE_FILES = NO 691 | 692 | #--------------------------------------------------------------------------- 693 | # configuration options related to source browsing 694 | #--------------------------------------------------------------------------- 695 | 696 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will 697 | # be generated. Documented entities will be cross-referenced with these sources. 698 | # Note: To get rid of all source code in the generated output, make sure also 699 | # VERBATIM_HEADERS is set to NO. 700 | 701 | SOURCE_BROWSER = NO 702 | 703 | # Setting the INLINE_SOURCES tag to YES will include the body 704 | # of functions and classes directly in the documentation. 705 | 706 | INLINE_SOURCES = YES 707 | 708 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 709 | # doxygen to hide any special comment blocks from generated source code 710 | # fragments. Normal C and C++ comments will always remain visible. 711 | 712 | STRIP_CODE_COMMENTS = YES 713 | 714 | # If the REFERENCED_BY_RELATION tag is set to YES 715 | # then for each documented function all documented 716 | # functions referencing it will be listed. 717 | 718 | REFERENCED_BY_RELATION = NO 719 | 720 | # If the REFERENCES_RELATION tag is set to YES 721 | # then for each documented function all documented entities 722 | # called/used by that function will be listed. 723 | 724 | REFERENCES_RELATION = NO 725 | 726 | # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 727 | # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 728 | # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 729 | # link to the source code. 730 | # Otherwise they will link to the documentation. 731 | 732 | REFERENCES_LINK_SOURCE = YES 733 | 734 | # If the USE_HTAGS tag is set to YES then the references to source code 735 | # will point to the HTML generated by the htags(1) tool instead of doxygen 736 | # built-in source browser. The htags tool is part of GNU's global source 737 | # tagging system (see http://www.gnu.org/software/global/global.html). You 738 | # will need version 4.8.6 or higher. 739 | 740 | USE_HTAGS = NO 741 | 742 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 743 | # will generate a verbatim copy of the header file for each class for 744 | # which an include is specified. Set to NO to disable this. 745 | 746 | VERBATIM_HEADERS = YES 747 | 748 | #--------------------------------------------------------------------------- 749 | # configuration options related to the alphabetical class index 750 | #--------------------------------------------------------------------------- 751 | 752 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 753 | # of all compounds will be generated. Enable this if the project 754 | # contains a lot of classes, structs, unions or interfaces. 755 | 756 | ALPHABETICAL_INDEX = YES 757 | 758 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 759 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 760 | # in which this list will be split (can be a number in the range [1..20]) 761 | 762 | COLS_IN_ALPHA_INDEX = 5 763 | 764 | # In case all classes in a project start with a common prefix, all 765 | # classes will be put under the same header in the alphabetical index. 766 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 767 | # should be ignored while generating the index headers. 768 | 769 | IGNORE_PREFIX = 770 | 771 | #--------------------------------------------------------------------------- 772 | # configuration options related to the HTML output 773 | #--------------------------------------------------------------------------- 774 | 775 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 776 | # generate HTML output. 777 | 778 | GENERATE_HTML = YES 779 | 780 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 781 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 782 | # put in front of it. If left blank `html' will be used as the default path. 783 | 784 | HTML_OUTPUT = html 785 | 786 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 787 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 788 | # doxygen will generate files with .html extension. 789 | 790 | HTML_FILE_EXTENSION = .html 791 | 792 | # The HTML_HEADER tag can be used to specify a personal HTML header for 793 | # each generated HTML page. If it is left blank doxygen will generate a 794 | # standard header. 795 | 796 | HTML_HEADER = 797 | 798 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for 799 | # each generated HTML page. If it is left blank doxygen will generate a 800 | # standard footer. 801 | 802 | HTML_FOOTER = 803 | 804 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 805 | # style sheet that is used by each HTML page. It can be used to 806 | # fine-tune the look of the HTML output. If the tag is left blank doxygen 807 | # will generate a default style sheet. Note that doxygen will try to copy 808 | # the style sheet file to the HTML output directory, so don't put your own 809 | # stylesheet in the HTML output directory as well, or it will be erased! 810 | 811 | HTML_STYLESHEET = 812 | 813 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 814 | # Doxygen will adjust the colors in the stylesheet and background images 815 | # according to this color. Hue is specified as an angle on a colorwheel, 816 | # see http://en.wikipedia.org/wiki/Hue for more information. 817 | # For instance the value 0 represents red, 60 is yellow, 120 is green, 818 | # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 819 | # The allowed range is 0 to 359. 820 | 821 | HTML_COLORSTYLE_HUE = 220 822 | 823 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 824 | # the colors in the HTML output. For a value of 0 the output will use 825 | # grayscales only. A value of 255 will produce the most vivid colors. 826 | 827 | HTML_COLORSTYLE_SAT = 100 828 | 829 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 830 | # the luminance component of the colors in the HTML output. Values below 831 | # 100 gradually make the output lighter, whereas values above 100 make 832 | # the output darker. The value divided by 100 is the actual gamma applied, 833 | # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 834 | # and 100 does not change the gamma. 835 | 836 | HTML_COLORSTYLE_GAMMA = 80 837 | 838 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 839 | # page will contain the date and time when the page was generated. Setting 840 | # this to NO can help when comparing the output of multiple runs. 841 | 842 | HTML_TIMESTAMP = YES 843 | 844 | # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 845 | # files or namespaces will be aligned in HTML using tables. If set to 846 | # NO a bullet list will be used. 847 | 848 | HTML_ALIGN_MEMBERS = YES 849 | 850 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 851 | # documentation will contain sections that can be hidden and shown after the 852 | # page has loaded. For this to work a browser that supports 853 | # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 854 | # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 855 | 856 | HTML_DYNAMIC_SECTIONS = NO 857 | 858 | # If the GENERATE_DOCSET tag is set to YES, additional index files 859 | # will be generated that can be used as input for Apple's Xcode 3 860 | # integrated development environment, introduced with OSX 10.5 (Leopard). 861 | # To create a documentation set, doxygen will generate a Makefile in the 862 | # HTML output directory. Running make will produce the docset in that 863 | # directory and running "make install" will install the docset in 864 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 865 | # it at startup. 866 | # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 867 | # for more information. 868 | 869 | GENERATE_DOCSET = NO 870 | 871 | # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 872 | # feed. A documentation feed provides an umbrella under which multiple 873 | # documentation sets from a single provider (such as a company or product suite) 874 | # can be grouped. 875 | 876 | DOCSET_FEEDNAME = "Doxygen generated docs" 877 | 878 | # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 879 | # should uniquely identify the documentation set bundle. This should be a 880 | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 881 | # will append .docset to the name. 882 | 883 | DOCSET_BUNDLE_ID = org.doxygen.Project 884 | 885 | # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 886 | # the documentation publisher. This should be a reverse domain-name style 887 | # string, e.g. com.mycompany.MyDocSet.documentation. 888 | 889 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 890 | 891 | # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 892 | 893 | DOCSET_PUBLISHER_NAME = Publisher 894 | 895 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files 896 | # will be generated that can be used as input for tools like the 897 | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 898 | # of the generated HTML documentation. 899 | 900 | GENERATE_HTMLHELP = NO 901 | 902 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 903 | # be used to specify the file name of the resulting .chm file. You 904 | # can add a path in front of the file if the result should not be 905 | # written to the html output directory. 906 | 907 | CHM_FILE = 908 | 909 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 910 | # be used to specify the location (absolute path including file name) of 911 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 912 | # the HTML help compiler on the generated index.hhp. 913 | 914 | HHC_LOCATION = 915 | 916 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 917 | # controls if a separate .chi index file is generated (YES) or that 918 | # it should be included in the master .chm file (NO). 919 | 920 | GENERATE_CHI = NO 921 | 922 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 923 | # is used to encode HtmlHelp index (hhk), content (hhc) and project file 924 | # content. 925 | 926 | CHM_INDEX_ENCODING = 927 | 928 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 929 | # controls whether a binary table of contents is generated (YES) or a 930 | # normal table of contents (NO) in the .chm file. 931 | 932 | BINARY_TOC = NO 933 | 934 | # The TOC_EXPAND flag can be set to YES to add extra items for group members 935 | # to the contents of the HTML help documentation and to the tree view. 936 | 937 | TOC_EXPAND = NO 938 | 939 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 940 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 941 | # that can be used as input for Qt's qhelpgenerator to generate a 942 | # Qt Compressed Help (.qch) of the generated HTML documentation. 943 | 944 | GENERATE_QHP = NO 945 | 946 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 947 | # be used to specify the file name of the resulting .qch file. 948 | # The path specified is relative to the HTML output folder. 949 | 950 | QCH_FILE = 951 | 952 | # The QHP_NAMESPACE tag specifies the namespace to use when generating 953 | # Qt Help Project output. For more information please see 954 | # http://doc.trolltech.com/qthelpproject.html#namespace 955 | 956 | QHP_NAMESPACE = org.doxygen.Project 957 | 958 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 959 | # Qt Help Project output. For more information please see 960 | # http://doc.trolltech.com/qthelpproject.html#virtual-folders 961 | 962 | QHP_VIRTUAL_FOLDER = doc 963 | 964 | # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 965 | # add. For more information please see 966 | # http://doc.trolltech.com/qthelpproject.html#custom-filters 967 | 968 | QHP_CUST_FILTER_NAME = 969 | 970 | # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 971 | # custom filter to add. For more information please see 972 | # 973 | # Qt Help Project / Custom Filters. 974 | 975 | QHP_CUST_FILTER_ATTRS = 976 | 977 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 978 | # project's 979 | # filter section matches. 980 | # 981 | # Qt Help Project / Filter Attributes. 982 | 983 | QHP_SECT_FILTER_ATTRS = 984 | 985 | # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 986 | # be used to specify the location of Qt's qhelpgenerator. 987 | # If non-empty doxygen will try to run qhelpgenerator on the generated 988 | # .qhp file. 989 | 990 | QHG_LOCATION = 991 | 992 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 993 | # will be generated, which together with the HTML files, form an Eclipse help 994 | # plugin. To install this plugin and make it available under the help contents 995 | # menu in Eclipse, the contents of the directory containing the HTML and XML 996 | # files needs to be copied into the plugins directory of eclipse. The name of 997 | # the directory within the plugins directory should be the same as 998 | # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 999 | # the help appears. 1000 | 1001 | GENERATE_ECLIPSEHELP = NO 1002 | 1003 | # A unique identifier for the eclipse help plugin. When installing the plugin 1004 | # the directory name containing the HTML and XML files should also have 1005 | # this name. 1006 | 1007 | ECLIPSE_DOC_ID = org.doxygen.Project 1008 | 1009 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 1010 | # top of each HTML page. The value NO (the default) enables the index and 1011 | # the value YES disables it. 1012 | 1013 | DISABLE_INDEX = NO 1014 | 1015 | # This tag can be used to set the number of enum values (range [0,1..20]) 1016 | # that doxygen will group on one line in the generated HTML documentation. 1017 | # Note that a value of 0 will completely suppress the enum values from appearing in the overview section. 1018 | 1019 | ENUM_VALUES_PER_LINE = 4 1020 | 1021 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1022 | # structure should be generated to display hierarchical information. 1023 | # If the tag value is set to YES, a side panel will be generated 1024 | # containing a tree-like index structure (just like the one that 1025 | # is generated for HTML Help). For this to work a browser that supports 1026 | # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1027 | # Windows users are probably better off using the HTML help feature. 1028 | 1029 | GENERATE_TREEVIEW = NO 1030 | 1031 | # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 1032 | # and Class Hierarchy pages using a tree view instead of an ordered list. 1033 | 1034 | USE_INLINE_TREES = NO 1035 | 1036 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1037 | # used to set the initial width (in pixels) of the frame in which the tree 1038 | # is shown. 1039 | 1040 | TREEVIEW_WIDTH = 250 1041 | 1042 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1043 | # links to external symbols imported via tag files in a separate window. 1044 | 1045 | EXT_LINKS_IN_WINDOW = NO 1046 | 1047 | # Use this tag to change the font size of Latex formulas included 1048 | # as images in the HTML documentation. The default is 10. Note that 1049 | # when you change the font size after a successful doxygen run you need 1050 | # to manually remove any form_*.png images from the HTML output directory 1051 | # to force them to be regenerated. 1052 | 1053 | FORMULA_FONTSIZE = 10 1054 | 1055 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1056 | # generated for formulas are transparent PNGs. Transparent PNGs are 1057 | # not supported properly for IE 6.0, but are supported on all modern browsers. 1058 | # Note that when changing this option you need to delete any form_*.png files 1059 | # in the HTML output before the changes have effect. 1060 | 1061 | FORMULA_TRANSPARENT = YES 1062 | 1063 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1064 | # (see http://www.mathjax.org) which uses client side Javascript for the 1065 | # rendering instead of using prerendered bitmaps. Use this if you do not 1066 | # have LaTeX installed or if you want to formulas look prettier in the HTML 1067 | # output. When enabled you also need to install MathJax separately and 1068 | # configure the path to it using the MATHJAX_RELPATH option. 1069 | 1070 | USE_MATHJAX = NO 1071 | 1072 | # When MathJax is enabled you need to specify the location relative to the 1073 | # HTML output directory using the MATHJAX_RELPATH option. The destination 1074 | # directory should contain the MathJax.js script. For instance, if the mathjax 1075 | # directory is located at the same level as the HTML output directory, then 1076 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing 1077 | # MathJax, but it is strongly recommended to install a local copy of MathJax 1078 | # before deployment. 1079 | 1080 | MATHJAX_RELPATH = http://www.mathjax.org/mathjax 1081 | 1082 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box 1083 | # for the HTML output. The underlying search engine uses javascript 1084 | # and DHTML and should work on any modern browser. Note that when using 1085 | # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1086 | # (GENERATE_DOCSET) there is already a search function so this one should 1087 | # typically be disabled. For large projects the javascript based search engine 1088 | # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1089 | 1090 | SEARCHENGINE = YES 1091 | 1092 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1093 | # implemented using a PHP enabled web server instead of at the web client 1094 | # using Javascript. Doxygen will generate the search PHP script and index 1095 | # file to put on the web server. The advantage of the server 1096 | # based approach is that it scales better to large projects and allows 1097 | # full text search. The disadvantages are that it is more difficult to setup 1098 | # and does not have live searching capabilities. 1099 | 1100 | SERVER_BASED_SEARCH = NO 1101 | 1102 | #--------------------------------------------------------------------------- 1103 | # configuration options related to the LaTeX output 1104 | #--------------------------------------------------------------------------- 1105 | 1106 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1107 | # generate Latex output. 1108 | 1109 | GENERATE_LATEX = NO 1110 | 1111 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1112 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1113 | # put in front of it. If left blank `latex' will be used as the default path. 1114 | 1115 | LATEX_OUTPUT = latex 1116 | 1117 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1118 | # invoked. If left blank `latex' will be used as the default command name. 1119 | # Note that when enabling USE_PDFLATEX this option is only used for 1120 | # generating bitmaps for formulas in the HTML output, but not in the 1121 | # Makefile that is written to the output directory. 1122 | 1123 | LATEX_CMD_NAME = latex 1124 | 1125 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1126 | # generate index for LaTeX. If left blank `makeindex' will be used as the 1127 | # default command name. 1128 | 1129 | MAKEINDEX_CMD_NAME = makeindex 1130 | 1131 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1132 | # LaTeX documents. This may be useful for small projects and may help to 1133 | # save some trees in general. 1134 | 1135 | COMPACT_LATEX = NO 1136 | 1137 | # The PAPER_TYPE tag can be used to set the paper type that is used 1138 | # by the printer. Possible values are: a4, letter, legal and 1139 | # executive. If left blank a4wide will be used. 1140 | 1141 | PAPER_TYPE = a4 1142 | 1143 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1144 | # packages that should be included in the LaTeX output. 1145 | 1146 | EXTRA_PACKAGES = 1147 | 1148 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1149 | # the generated latex document. The header should contain everything until 1150 | # the first chapter. If it is left blank doxygen will generate a 1151 | # standard header. Notice: only use this tag if you know what you are doing! 1152 | 1153 | LATEX_HEADER = 1154 | 1155 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1156 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will 1157 | # contain links (just like the HTML output) instead of page references 1158 | # This makes the output suitable for online browsing using a pdf viewer. 1159 | 1160 | PDF_HYPERLINKS = YES 1161 | 1162 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1163 | # plain latex in the generated Makefile. Set this option to YES to get a 1164 | # higher quality PDF documentation. 1165 | 1166 | USE_PDFLATEX = YES 1167 | 1168 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1169 | # command to the generated LaTeX files. This will instruct LaTeX to keep 1170 | # running if errors occur, instead of asking the user for help. 1171 | # This option is also used when generating formulas in HTML. 1172 | 1173 | LATEX_BATCHMODE = NO 1174 | 1175 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not 1176 | # include the index chapters (such as File Index, Compound Index, etc.) 1177 | # in the output. 1178 | 1179 | LATEX_HIDE_INDICES = NO 1180 | 1181 | # If LATEX_SOURCE_CODE is set to YES then doxygen will include 1182 | # source code with syntax highlighting in the LaTeX output. 1183 | # Note that which sources are shown also depends on other settings 1184 | # such as SOURCE_BROWSER. 1185 | 1186 | LATEX_SOURCE_CODE = NO 1187 | 1188 | #--------------------------------------------------------------------------- 1189 | # configuration options related to the RTF output 1190 | #--------------------------------------------------------------------------- 1191 | 1192 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1193 | # The RTF output is optimized for Word 97 and may not look very pretty with 1194 | # other RTF readers or editors. 1195 | 1196 | GENERATE_RTF = NO 1197 | 1198 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1199 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1200 | # put in front of it. If left blank `rtf' will be used as the default path. 1201 | 1202 | RTF_OUTPUT = rtf 1203 | 1204 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1205 | # RTF documents. This may be useful for small projects and may help to 1206 | # save some trees in general. 1207 | 1208 | COMPACT_RTF = NO 1209 | 1210 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1211 | # will contain hyperlink fields. The RTF file will 1212 | # contain links (just like the HTML output) instead of page references. 1213 | # This makes the output suitable for online browsing using WORD or other 1214 | # programs which support those fields. 1215 | # Note: wordpad (write) and others do not support links. 1216 | 1217 | RTF_HYPERLINKS = NO 1218 | 1219 | # Load stylesheet definitions from file. Syntax is similar to doxygen's 1220 | # config file, i.e. a series of assignments. You only have to provide 1221 | # replacements, missing definitions are set to their default value. 1222 | 1223 | RTF_STYLESHEET_FILE = 1224 | 1225 | # Set optional variables used in the generation of an rtf document. 1226 | # Syntax is similar to doxygen's config file. 1227 | 1228 | RTF_EXTENSIONS_FILE = 1229 | 1230 | #--------------------------------------------------------------------------- 1231 | # configuration options related to the man page output 1232 | #--------------------------------------------------------------------------- 1233 | 1234 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1235 | # generate man pages 1236 | 1237 | GENERATE_MAN = NO 1238 | 1239 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. 1240 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1241 | # put in front of it. If left blank `man' will be used as the default path. 1242 | 1243 | MAN_OUTPUT = man 1244 | 1245 | # The MAN_EXTENSION tag determines the extension that is added to 1246 | # the generated man pages (default is the subroutine's section .3) 1247 | 1248 | MAN_EXTENSION = .3 1249 | 1250 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1251 | # then it will generate one additional man file for each entity 1252 | # documented in the real man page(s). These additional files 1253 | # only source the real man page, but without them the man command 1254 | # would be unable to find the correct page. The default is NO. 1255 | 1256 | MAN_LINKS = NO 1257 | 1258 | #--------------------------------------------------------------------------- 1259 | # configuration options related to the XML output 1260 | #--------------------------------------------------------------------------- 1261 | 1262 | # If the GENERATE_XML tag is set to YES Doxygen will 1263 | # generate an XML file that captures the structure of 1264 | # the code including all documentation. 1265 | 1266 | GENERATE_XML = NO 1267 | 1268 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. 1269 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1270 | # put in front of it. If left blank `xml' will be used as the default path. 1271 | 1272 | XML_OUTPUT = xml 1273 | 1274 | # The XML_SCHEMA tag can be used to specify an XML schema, 1275 | # which can be used by a validating XML parser to check the 1276 | # syntax of the XML files. 1277 | 1278 | XML_SCHEMA = 1279 | 1280 | # The XML_DTD tag can be used to specify an XML DTD, 1281 | # which can be used by a validating XML parser to check the 1282 | # syntax of the XML files. 1283 | 1284 | XML_DTD = 1285 | 1286 | # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1287 | # dump the program listings (including syntax highlighting 1288 | # and cross-referencing information) to the XML output. Note that 1289 | # enabling this will significantly increase the size of the XML output. 1290 | 1291 | XML_PROGRAMLISTING = YES 1292 | 1293 | #--------------------------------------------------------------------------- 1294 | # configuration options for the AutoGen Definitions output 1295 | #--------------------------------------------------------------------------- 1296 | 1297 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1298 | # generate an AutoGen Definitions (see autogen.sf.net) file 1299 | # that captures the structure of the code including all 1300 | # documentation. Note that this feature is still experimental 1301 | # and incomplete at the moment. 1302 | 1303 | GENERATE_AUTOGEN_DEF = NO 1304 | 1305 | #--------------------------------------------------------------------------- 1306 | # configuration options related to the Perl module output 1307 | #--------------------------------------------------------------------------- 1308 | 1309 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will 1310 | # generate a Perl module file that captures the structure of 1311 | # the code including all documentation. Note that this 1312 | # feature is still experimental and incomplete at the 1313 | # moment. 1314 | 1315 | GENERATE_PERLMOD = NO 1316 | 1317 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1318 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able 1319 | # to generate PDF and DVI output from the Perl module output. 1320 | 1321 | PERLMOD_LATEX = NO 1322 | 1323 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1324 | # nicely formatted so it can be parsed by a human reader. 1325 | # This is useful 1326 | # if you want to understand what is going on. 1327 | # On the other hand, if this 1328 | # tag is set to NO the size of the Perl module output will be much smaller 1329 | # and Perl will parse it just the same. 1330 | 1331 | PERLMOD_PRETTY = YES 1332 | 1333 | # The names of the make variables in the generated doxyrules.make file 1334 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1335 | # This is useful so different doxyrules.make files included by the same 1336 | # Makefile don't overwrite each other's variables. 1337 | 1338 | PERLMOD_MAKEVAR_PREFIX = 1339 | 1340 | #--------------------------------------------------------------------------- 1341 | # Configuration options related to the preprocessor 1342 | #--------------------------------------------------------------------------- 1343 | 1344 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1345 | # evaluate all C-preprocessor directives found in the sources and include 1346 | # files. 1347 | 1348 | ENABLE_PREPROCESSING = YES 1349 | 1350 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1351 | # names in the source code. If set to NO (the default) only conditional 1352 | # compilation will be performed. Macro expansion can be done in a controlled 1353 | # way by setting EXPAND_ONLY_PREDEF to YES. 1354 | 1355 | MACRO_EXPANSION = NO 1356 | 1357 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1358 | # then the macro expansion is limited to the macros specified with the 1359 | # PREDEFINED and EXPAND_AS_DEFINED tags. 1360 | 1361 | EXPAND_ONLY_PREDEF = NO 1362 | 1363 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1364 | # in the INCLUDE_PATH (see below) will be search if a #include is found. 1365 | 1366 | SEARCH_INCLUDES = YES 1367 | 1368 | # The INCLUDE_PATH tag can be used to specify one or more directories that 1369 | # contain include files that are not input files but should be processed by 1370 | # the preprocessor. 1371 | 1372 | INCLUDE_PATH = 1373 | 1374 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1375 | # patterns (like *.h and *.hpp) to filter out the header-files in the 1376 | # directories. If left blank, the patterns specified with FILE_PATTERNS will 1377 | # be used. 1378 | 1379 | INCLUDE_FILE_PATTERNS = 1380 | 1381 | # The PREDEFINED tag can be used to specify one or more macro names that 1382 | # are defined before the preprocessor is started (similar to the -D option of 1383 | # gcc). The argument of the tag is a list of macros of the form: name 1384 | # or name=definition (no spaces). If the definition and the = are 1385 | # omitted =1 is assumed. To prevent a macro definition from being 1386 | # undefined via #undef or recursively expanded use the := operator 1387 | # instead of the = operator. 1388 | 1389 | PREDEFINED = 1390 | 1391 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1392 | # this tag can be used to specify a list of macro names that should be expanded. 1393 | # The macro definition that is found in the sources will be used. 1394 | # Use the PREDEFINED tag if you want to use a different macro definition. 1395 | 1396 | EXPAND_AS_DEFINED = 1397 | 1398 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1399 | # doxygen's preprocessor will remove all function-like macros that are alone 1400 | # on a line, have an all uppercase name, and do not end with a semicolon. Such 1401 | # function macros are typically used for boiler-plate code, and will confuse 1402 | # the parser if not removed. 1403 | 1404 | SKIP_FUNCTION_MACROS = YES 1405 | 1406 | #--------------------------------------------------------------------------- 1407 | # Configuration::additions related to external references 1408 | #--------------------------------------------------------------------------- 1409 | 1410 | # The TAGFILES option can be used to specify one or more tagfiles. 1411 | # Optionally an initial location of the external documentation 1412 | # can be added for each tagfile. The format of a tag file without 1413 | # this location is as follows: 1414 | # 1415 | # TAGFILES = file1 file2 ... 1416 | # Adding location for the tag files is done as follows: 1417 | # 1418 | # TAGFILES = file1=loc1 "file2 = loc2" ... 1419 | # where "loc1" and "loc2" can be relative or absolute paths or 1420 | # URLs. If a location is present for each tag, the installdox tool 1421 | # does not have to be run to correct the links. 1422 | # Note that each tag file must have a unique name 1423 | # (where the name does NOT include the path) 1424 | # If a tag file is not located in the directory in which doxygen 1425 | # is run, you must also specify the path to the tagfile here. 1426 | 1427 | TAGFILES = 1428 | 1429 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1430 | # a tag file that is based on the input files it reads. 1431 | 1432 | GENERATE_TAGFILE = 1433 | 1434 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1435 | # in the class index. If set to NO only the inherited external classes 1436 | # will be listed. 1437 | 1438 | ALLEXTERNALS = NO 1439 | 1440 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1441 | # in the modules index. If set to NO, only the current project's groups will 1442 | # be listed. 1443 | 1444 | EXTERNAL_GROUPS = YES 1445 | 1446 | # The PERL_PATH should be the absolute path and name of the perl script 1447 | # interpreter (i.e. the result of `which perl'). 1448 | 1449 | PERL_PATH = /usr/bin/perl 1450 | 1451 | #--------------------------------------------------------------------------- 1452 | # Configuration options related to the dot tool 1453 | #--------------------------------------------------------------------------- 1454 | 1455 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1456 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1457 | # or super classes. Setting the tag to NO turns the diagrams off. Note that 1458 | # this option also works with HAVE_DOT disabled, but it is recommended to 1459 | # install and use dot, since it yields more powerful graphs. 1460 | 1461 | CLASS_DIAGRAMS = YES 1462 | 1463 | # You can define message sequence charts within doxygen comments using the \msc 1464 | # command. Doxygen will then run the mscgen tool (see 1465 | # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1466 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where 1467 | # the mscgen tool resides. If left empty the tool is assumed to be found in the 1468 | # default search path. 1469 | 1470 | MSCGEN_PATH = 1471 | 1472 | # If set to YES, the inheritance and collaboration graphs will hide 1473 | # inheritance and usage relations if the target is undocumented 1474 | # or is not a class. 1475 | 1476 | HIDE_UNDOC_RELATIONS = YES 1477 | 1478 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1479 | # available from the path. This tool is part of Graphviz, a graph visualization 1480 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1481 | # have no effect if this option is set to NO (the default) 1482 | 1483 | HAVE_DOT = YES 1484 | 1485 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1486 | # allowed to run in parallel. When set to 0 (the default) doxygen will 1487 | # base this on the number of processors available in the system. You can set it 1488 | # explicitly to a value larger than 0 to get control over the balance 1489 | # between CPU load and processing speed. 1490 | 1491 | DOT_NUM_THREADS = 0 1492 | 1493 | # By default doxygen will write a font called FreeSans.ttf to the output 1494 | # directory and reference it in all dot files that doxygen generates. This 1495 | # font does not include all possible unicode characters however, so when you need 1496 | # these (or just want a differently looking font) you can specify the font name 1497 | # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1498 | # which can be done by putting it in a standard location or by setting the 1499 | # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1500 | # containing the font. 1501 | 1502 | DOT_FONTNAME = FreeSans.ttf 1503 | 1504 | # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1505 | # The default size is 10pt. 1506 | 1507 | DOT_FONTSIZE = 10 1508 | 1509 | # By default doxygen will tell dot to use the output directory to look for the 1510 | # FreeSans.ttf font (which doxygen will put there itself). If you specify a 1511 | # different font using DOT_FONTNAME you can set the path where dot 1512 | # can find it using this tag. 1513 | 1514 | DOT_FONTPATH = 1515 | 1516 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1517 | # will generate a graph for each documented class showing the direct and 1518 | # indirect inheritance relations. Setting this tag to YES will force the 1519 | # the CLASS_DIAGRAMS tag to NO. 1520 | 1521 | CLASS_GRAPH = YES 1522 | 1523 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1524 | # will generate a graph for each documented class showing the direct and 1525 | # indirect implementation dependencies (inheritance, containment, and 1526 | # class references variables) of the class with other documented classes. 1527 | 1528 | COLLABORATION_GRAPH = YES 1529 | 1530 | # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1531 | # will generate a graph for groups, showing the direct groups dependencies 1532 | 1533 | GROUP_GRAPHS = YES 1534 | 1535 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1536 | # collaboration diagrams in a style similar to the OMG's Unified Modeling 1537 | # Language. 1538 | 1539 | UML_LOOK = NO 1540 | 1541 | # If set to YES, the inheritance and collaboration graphs will show the 1542 | # relations between templates and their instances. 1543 | 1544 | TEMPLATE_RELATIONS = NO 1545 | 1546 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1547 | # tags are set to YES then doxygen will generate a graph for each documented 1548 | # file showing the direct and indirect include dependencies of the file with 1549 | # other documented files. 1550 | 1551 | INCLUDE_GRAPH = YES 1552 | 1553 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1554 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1555 | # documented header file showing the documented files that directly or 1556 | # indirectly include this file. 1557 | 1558 | INCLUDED_BY_GRAPH = YES 1559 | 1560 | # If the CALL_GRAPH and HAVE_DOT options are set to YES then 1561 | # doxygen will generate a call dependency graph for every global function 1562 | # or class method. Note that enabling this option will significantly increase 1563 | # the time of a run. So in most cases it will be better to enable call graphs 1564 | # for selected functions only using the \callgraph command. 1565 | 1566 | CALL_GRAPH = NO 1567 | 1568 | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1569 | # doxygen will generate a caller dependency graph for every global function 1570 | # or class method. Note that enabling this option will significantly increase 1571 | # the time of a run. So in most cases it will be better to enable caller 1572 | # graphs for selected functions only using the \callergraph command. 1573 | 1574 | CALLER_GRAPH = NO 1575 | 1576 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1577 | # will generate a graphical hierarchy of all classes instead of a textual one. 1578 | 1579 | GRAPHICAL_HIERARCHY = YES 1580 | 1581 | # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1582 | # then doxygen will show the dependencies a directory has on other directories 1583 | # in a graphical way. The dependency relations are determined by the #include 1584 | # relations between the files in the directories. 1585 | 1586 | DIRECTORY_GRAPH = YES 1587 | 1588 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1589 | # generated by dot. Possible values are png, jpg, or gif. 1590 | # If left blank png will be used. 1591 | 1592 | DOT_IMAGE_FORMAT = png 1593 | 1594 | # The tag DOT_PATH can be used to specify the path where the dot tool can be 1595 | # found. If left blank, it is assumed the dot tool can be found in the path. 1596 | 1597 | DOT_PATH = 1598 | 1599 | # The DOTFILE_DIRS tag can be used to specify one or more directories that 1600 | # contain dot files that are included in the documentation (see the 1601 | # \dotfile command). 1602 | 1603 | DOTFILE_DIRS = 1604 | 1605 | # The MSCFILE_DIRS tag can be used to specify one or more directories that 1606 | # contain msc files that are included in the documentation (see the 1607 | # \mscfile command). 1608 | 1609 | MSCFILE_DIRS = 1610 | 1611 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1612 | # nodes that will be shown in the graph. If the number of nodes in a graph 1613 | # becomes larger than this value, doxygen will truncate the graph, which is 1614 | # visualized by representing a node as a red box. Note that doxygen if the 1615 | # number of direct children of the root node in a graph is already larger than 1616 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1617 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1618 | 1619 | DOT_GRAPH_MAX_NODES = 50 1620 | 1621 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1622 | # graphs generated by dot. A depth value of 3 means that only nodes reachable 1623 | # from the root by following a path via at most 3 edges will be shown. Nodes 1624 | # that lay further from the root node will be omitted. Note that setting this 1625 | # option to 1 or 2 may greatly reduce the computation time needed for large 1626 | # code bases. Also note that the size of a graph can be further restricted by 1627 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1628 | 1629 | MAX_DOT_GRAPH_DEPTH = 0 1630 | 1631 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1632 | # background. This is disabled by default, because dot on Windows does not 1633 | # seem to support this out of the box. Warning: Depending on the platform used, 1634 | # enabling this option may lead to badly anti-aliased labels on the edges of 1635 | # a graph (i.e. they become hard to read). 1636 | 1637 | DOT_TRANSPARENT = NO 1638 | 1639 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1640 | # files in one run (i.e. multiple -o and -T options on the command line). This 1641 | # makes dot run faster, but since only newer versions of dot (>1.8.10) 1642 | # support this, this feature is disabled by default. 1643 | 1644 | DOT_MULTI_TARGETS = NO 1645 | 1646 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1647 | # generate a legend page explaining the meaning of the various boxes and 1648 | # arrows in the dot generated graphs. 1649 | 1650 | GENERATE_LEGEND = YES 1651 | 1652 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1653 | # remove the intermediate dot files that are used to generate 1654 | # the various graphs. 1655 | 1656 | DOT_CLEANUP = YES 1657 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | RM := rm -rf 2 | 3 | SRCs_conv=src/CryptImpHook_Conv.c src/Cipher.c 4 | SRCs_crypto=src/CryptImpHook.c src/Cipher.c 5 | OBJS_crypto=CryptImpHook.o Cipher.o 6 | PYTHON_CFLAGS=$(shell python-config --includes) 7 | PYTHON_LDFLAGS=$(shell python-config --libs) 8 | PYTHON_LIBDIR=-L$(shell python-config --prefix)/lib 9 | CFLAGS=-Wall 10 | 11 | # All Target 12 | all: CryptImpHook.so CryptConv 13 | @echo ' ' 14 | @echo ' ' 15 | @echo '********* Please, run "make test" now ***********' 16 | @echo ' ' 17 | @echo ' ' 18 | 19 | CryptConv: $(SRCs_conv) 20 | @echo 'Compiling CryptImpHook' 21 | $(CC) -o "dist/CryptConv" $(SRCs_conv) 22 | 23 | CryptImpHook.o: src/CryptImpHook.c 24 | @echo 'Compiling CryptImpHook' 25 | $(CC) -fPIC -c -I./src/ $(PYTHON_CFLAGS) src/CryptImpHook.c 26 | 27 | Cipher.o: src/Cipher.c 28 | @echo 'Compiling DEC' 29 | $(CC) -fPIC -c -I./src/ $(PYTHON_CFLAGS) src/Cipher.c 30 | 31 | # Tool invocations 32 | CryptImpHook.so: $(OBJS_crypto) 33 | @echo 'Building target: $@' 34 | @echo 'Invoking: GCC C Linker' 35 | -@mkdir dist 36 | $(CC) $(CFLAGS) -ggdb -g -O2 -fPIC -shared -o "dist/CryptImpHook.so" $(PYTHON_LIBDIR) $(PYTHON_LDFLAGS) $(OBJS_crypto) 37 | @echo 'Finished building target: $@' 38 | @echo ' ' 39 | 40 | # Other Targets 41 | clean: 42 | -$(RM) $(OBJS_crypto) dist 43 | -$(RM) EncModule.pye 44 | -$(RM) docs 45 | -@echo ' ' 46 | 47 | docs: 48 | -doxygen 49 | 50 | test: 51 | python runtests.py 52 | 53 | .PHONY: all clean docs test 54 | .SECONDARY: 55 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | CryptImpHook 2 | ============ 3 | 4 | Status: [![Build Status](https://travis-ci.org/neurogeek/python-crypt-import-hooks.png?branch=master)](https://travis-ci.org/neurogeek/python-crypt-import-hooks) 5 | 6 | /*! 7 | * \mainpage CryptImpHook.c 8 | * 9 | * \version 1.0 10 | * \date 2011 11 | * \author Jesus Rivero (Neurogeek) , 12 | * 13 | * \section Main 14 | * CryptImpHook is a CPython Import Hook (see PEP-302) that allows encrypted Python modules 15 | * to be used in a transparent manner in any Python application. The encrypted 16 | * modules have a .pye extension. 17 | * 18 | * This code is just a proof-of-concept and implements the XOR encryption 19 | * with a given key. If you would like to change the encryption cipher or mechanism, you could 20 | * implement yours by re_writing the cih_read_module_code function. 21 | * 22 | * This is public domain code. 23 | */ 24 | 25 | To build & test, just run: make && make test 26 | For docs, run: make docs 27 | 28 | This requires Python =< 2.7 to run. 29 | 30 | You will find the key in src/CryptImpHook.h. 31 | To encrypt your Python modules, use dist/CryptConv 32 | Encrypted Python modules will have a .pye extension. 33 | 34 | 35 | Disclaimer: 36 | 37 | XOR cipher is not a strong encryption algorithm. You should not use this code in Production systems. 38 | This is just a proof-of-concept, to be completely useful, you should implement the encryption/decryption with some 39 | proven algorithm or cipher, like AES or 3DES, use a large char[] for your key, and add -O2 to the code so it gets harder 40 | for anybody to dissect the key. 41 | -------------------------------------------------------------------------------- /configure: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #Dummy configure for Travis-CI 4 | exit 0 5 | -------------------------------------------------------------------------------- /runtests.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | #encoding: utf-8 3 | 4 | from __future__ import print_function 5 | import os 6 | import sys 7 | from subprocess import STDOUT, Popen 8 | 9 | #Add dist to PYTHONPATH 10 | sys.path.append("/".join([os.path.abspath("."), "dist"])) 11 | 12 | #We run our converter to cipher the module 13 | CryptConv = "dist/CryptConv" 14 | p = Popen(" ".join([CryptConv, "test_script.py", "EncModule.pye"]), shell=True) 15 | p.wait() 16 | 17 | p = Popen(" ".join([CryptConv, "test_script_b.py", "EncModuleB.pye"]), shell=True) 18 | p.wait() 19 | 20 | #Now, for the Actual Test 21 | print("Starting Test. Importing CryptImpHook", end="\n") 22 | from CryptImpHook import CryptImpHook 23 | print("Adding CryptImpHook to meta_path", end="\n") 24 | sys.meta_path.append(CryptImpHook()) 25 | print("Import class C from EncModule", end="\n") 26 | 27 | 28 | #Now lets import our Module 29 | import EncModule 30 | EncModule.C(1, 2, 3) 31 | 32 | import EncModuleB 33 | EncModuleB.some_function_b(4, 5, 6) 34 | -------------------------------------------------------------------------------- /src/Cipher.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Cipher.c 3 | * 4 | * Created on: Jul 16, 2011 5 | * Author: Jesus Rivero (Neurogeek) 6 | * 7 | * 8 | * LGPL-2.1. The license and distribution terms for this file may be 9 | * found in the file LICENSE in this distribution or at 10 | */ 11 | 12 | /*! 13 | * \brief Applies bitwise XOR to two chars. 14 | * \param btoenc (char) is the first element (a char from a plaintext.) 15 | * \param keybit (char) a char from the key. 16 | * \return XOR operation result. 17 | */ 18 | int XOR(char btoenc, char keybit) 19 | { 20 | return btoenc ^ keybit; 21 | } 22 | 23 | -------------------------------------------------------------------------------- /src/Cipher.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Cipher.h 3 | * 4 | * LGPL-2.1. The license and distribution terms for this file may be 5 | * found in the file LICENSE in this distribution or at 6 | * 7 | * Created on: Jul 16, 2011 8 | * Author: Jesus Rivero (Neurogeek) 9 | * 10 | */ 11 | 12 | int XOR(char btoenc, char keybit); 13 | -------------------------------------------------------------------------------- /src/CryptImpHook.c: -------------------------------------------------------------------------------- 1 | /*! 2 | * \mainpage CryptImpHook.c 3 | * 4 | * \version 1.0 5 | * \date 2011 6 | * \author Jesus Rivero (Neurogeek) , 7 | * 8 | * LGPL-2.1. The license and distribution terms for this file may be 9 | * found in the file LICENSE in this distribution or at 10 | * 11 | * \section Main 12 | * CryptImpHook is a CPython Import Hook (see PEP-302) that allows encrypted Python modules 13 | * to be used in a transparent manner in any Python application. The encrypted 14 | * modules have a .pyx extension. 15 | * 16 | * This code is just a proof-of-concept and implements the XOR encryption 17 | * with a given key. If you would like to change the encryption cipher or mechanism, you could 18 | * implement yours by re_writing the cih_read_module_code function. 19 | * 20 | */ 21 | #include 22 | 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | 30 | #include "Cipher.h" 31 | #include "CryptImpHook.h" 32 | 33 | ///! Some constants used for the new imported module. 34 | const char *FILE_ITEM = "__file__"; 35 | const char *LOADER_ITEM = "__loader__"; 36 | const char *DICT_ITEM = "__dict__"; 37 | 38 | ///! The Python type for the Object 39 | static PyTypeObject CryptImpHook_Type; 40 | 41 | ///! The new suffix for encrypted Python modules. 42 | ///! Just for convinience. 43 | static const char *IMPHOOK_SUFFIX = ".pye"; 44 | 45 | /*! \struct CryptImpHook 46 | * \brief PyObject initial segment, plus a new attribute to hold 47 | * the name of the file of the module to be imported. 48 | */ 49 | typedef struct { 50 | PyObject_HEAD 51 | PyObject *mod_file; 52 | } CryptImpHook; 53 | 54 | ///! Constructor 55 | static PyObject * 56 | CryptImpHook_NEW() 57 | { 58 | CryptImpHook *hook; 59 | 60 | hook = PyObject_NEW(CryptImpHook, &CryptImpHook_Type); 61 | hook->mod_file = PyString_FromString(""); 62 | Py_INCREF(hook->mod_file); 63 | 64 | return (PyObject *)hook; 65 | } 66 | 67 | ///! Destructor 68 | static void 69 | CryptImpHook_dealloc(self) 70 | PyObject *self; 71 | { 72 | CryptImpHook *hook = (CryptImpHook *)self; 73 | Py_DECREF(hook->mod_file); 74 | Py_DECREF(self); 75 | } 76 | 77 | /* 78 | * Methods 79 | * We need to implement and expose two methods for the Hook: 80 | * - find_module: which is called from import. It shall return an object if it should be used for loading. 81 | * - load_module: which is called is find_module returns a Not None object. This returns the module. 82 | */ 83 | 84 | /*! 85 | * \brief Finds out if a file with an IMPHOOK_SUFFIX exists. 86 | * \param fullname is the name (no suffix/extension) of the file to search for 87 | * \return the complete path of the file, or NULL if no matching file exists. 88 | */ 89 | char * 90 | cih_get_path(const char *fullname) 91 | { 92 | int res; 93 | ssize_t ssize; 94 | struct stat buf; 95 | char *filename; 96 | 97 | filename = (char *)malloc(sizeof(char) * 512); 98 | filename = (char *)memset(filename, 0, sizeof(char) * 512); 99 | 100 | ssize = strlen(fullname); 101 | strncat(filename, fullname, ssize); 102 | strncat(filename, IMPHOOK_SUFFIX, strlen(IMPHOOK_SUFFIX)); 103 | 104 | //We should have our filename as fullname.pyx. 105 | //If we find it, then we should return self. 106 | res = stat(filename, &buf); 107 | 108 | if(res == 0){ 109 | return filename; 110 | } 111 | 112 | return NULL; 113 | } 114 | 115 | /*! \brief Reads and decrypts a file from a path. 116 | * \param filename The fullname of a file, path included. 117 | * \return The decoded string, or NULL if an Error ocurred. 118 | */ 119 | char * 120 | cih_read_module_code(char *filename) 121 | //CryptImpHook_cih_read_module_code(PyObject *filename) 122 | { 123 | FILE *fp; 124 | ssize_t total; 125 | struct stat buf; 126 | int err, dec_len; 127 | int idx = 0; 128 | int ktal = strlen(qta); 129 | int btodec; 130 | char *temp, *tmp_name; 131 | char *dec_module_code; 132 | 133 | temp = (char *)malloc(sizeof(char) + 1); 134 | tmp_name = (char *)malloc(sizeof(char) * (strlen(filename) + strlen(IMPHOOK_SUFFIX)) + 2); 135 | sprintf(tmp_name, "%s%s", filename, IMPHOOK_SUFFIX); 136 | 137 | if ((err = stat(tmp_name, &buf)) != 0) { 138 | printf("Error ocurred %d\n", errno); 139 | return NULL; 140 | } 141 | 142 | dec_module_code = (char *)malloc(sizeof(char) * buf.st_size + 1); //We grab the file size in bytes 143 | memset(dec_module_code, 0, sizeof(char) * buf.st_size); 144 | 145 | if(dec_module_code == NULL){ 146 | return NULL; 147 | } 148 | 149 | fp = fopen(tmp_name, "r"); 150 | while( (btodec = fgetc(fp)) != EOF ) 151 | { 152 | sprintf(temp, "%c", XOR(btodec, qta[idx % ktal])); 153 | strcat(dec_module_code, temp); 154 | idx++; 155 | } 156 | err = ferror(fp); 157 | 158 | if((err)) 159 | { 160 | return NULL; 161 | } 162 | 163 | fclose(fp); 164 | 165 | free(temp); 166 | free(tmp_name); 167 | 168 | return dec_module_code; 169 | } 170 | 171 | /*! \brief This is the implementation of the Object's find_module. 172 | * 173 | * According to Python's PEP 302, Import Hooks should expose at least two functions. This 174 | * is one of them. 175 | * 176 | * \param self Pointer to the CryptImpHook Object. 177 | * \param args PyObject representing *args list. This one can have one or two elements. The first 178 | * one is the module name, the second, a path. 179 | * \return self (a PyObject) is the module exists, NULL if it does not exist. 180 | */ 181 | PyObject * 182 | CryptImpHook_find_module(self, args) 183 | PyObject *self, *args; 184 | { 185 | int err; 186 | char *filename, *fullname, *path; 187 | CryptImpHook *hook = (CryptImpHook *)self; 188 | 189 | err = PyArg_ParseTuple(args, "s|z", &fullname, &path); 190 | 191 | if(err == 0) 192 | { 193 | PyObject_Print(PyErr_Occurred(), stdout, Py_PRINT_RAW); 194 | PySys_WriteStdout("\n"); 195 | PyErr_Print(); 196 | PySys_WriteStdout("\n"); 197 | } 198 | 199 | filename = cih_get_path(fullname); 200 | 201 | if(filename != NULL) 202 | { 203 | hook->mod_file = PyString_FromString(filename); 204 | free(filename); 205 | return self; 206 | }else{ 207 | free(filename); 208 | return Py_None; 209 | } 210 | } 211 | 212 | /*! \brief Function to load the Python module. 213 | * 214 | * This is the second function that an ImportHook has to expose. This function 215 | * reads the module, decrypts it, creates a new Python module, configures it and returns it. 216 | * 217 | * \param self Pointer to the CryptImpHook Object. 218 | * \param args PyObject representing *args list. This onw has one element that represents the fullname (with path) 219 | * of the file containing the searched module. 220 | * \returns A new Python module all set, or NULL if an error ocurred. 221 | * \todo Clean up and look for failures. 222 | */ 223 | PyObject * 224 | CryptImpHook_load_module(self, args) 225 | PyObject *self, *args; 226 | { 227 | int err; 228 | char *module_code, *fullname; 229 | PyObject *new_mod, *sys_module_dict, *new_module_dict, *res; 230 | 231 | CryptImpHook *hook = (CryptImpHook *)self; 232 | 233 | PyArg_ParseTuple(args, "s", &fullname); 234 | new_mod = PyModule_New(fullname); 235 | Py_INCREF(new_mod); 236 | 237 | err = PyModule_AddObject(new_mod, FILE_ITEM, hook->mod_file); 238 | if(err != 0) 239 | { 240 | PyObject_Print(PyErr_Occurred(), stdout, Py_PRINT_RAW); 241 | PySys_WriteStdout("\n"); 242 | PyErr_Print(); 243 | PySys_WriteStdout("\n"); 244 | } 245 | err = PyModule_AddObject(new_mod, LOADER_ITEM, self); 246 | 247 | if(err != 0) 248 | { 249 | PyObject_Print(PyErr_Occurred(), stdout, Py_PRINT_RAW); 250 | PySys_WriteStdout("\n"); 251 | PyErr_Print(); 252 | PySys_WriteStdout("\n"); 253 | } 254 | 255 | sys_module_dict = PyImport_GetModuleDict(); 256 | 257 | if(sys_module_dict != NULL) 258 | { 259 | PyDict_SetItemString(sys_module_dict, fullname, new_mod); 260 | PyModule_AddObject(new_mod, "__builtins__", PyDict_GetItemString(sys_module_dict, "__builtin__")); 261 | } 262 | 263 | module_code = cih_read_module_code(fullname); 264 | //Next, we grab the reference to the new module's __dict__ 265 | 266 | if(module_code == NULL) { 267 | //We couldnt load the module. Raise ImportError 268 | return PyExc_ImportError; 269 | } 270 | new_module_dict = PyModule_GetDict(new_mod); 271 | 272 | /* 273 | * This is really important. the second arg should be Py_file_input because we need 274 | * the interpreter to believe is a file, and accept multiple statements in multiple lines. 275 | * Else, the plug-in should throw a SegFault. 276 | */ 277 | 278 | /* Now eval in context with new_mod.__dict__ in both globals and locals; 279 | * The following (I believe) would be the translation in C of the 280 | * exec CODE in mod.__dict__ 281 | */ 282 | res = PyRun_String(module_code, Py_file_input, new_module_dict, new_module_dict); 283 | return new_mod; 284 | } 285 | 286 | ///! MethodTable for CryptImpHook 287 | static PyMethodDef CryptImpHook_methods[] = { 288 | {"find_module", CryptImpHook_find_module, METH_VARARGS}, 289 | {"load_module", CryptImpHook_load_module, METH_VARARGS}, 290 | {NULL, NULL}, 291 | }; 292 | 293 | ///! We provide a getattr method 294 | static PyObject * 295 | CryptImpHook_GetAttr(self, attrname) 296 | PyObject *self; 297 | char *attrname; 298 | { 299 | return Py_FindMethod(CryptImpHook_methods, self, attrname); 300 | } 301 | 302 | ///! Type definition. Continuation of the static(forward) declaration 303 | static PyTypeObject CryptImpHook_Type = { 304 | PyObject_HEAD_INIT(&PyType_Type) 305 | 0, 306 | "CryptImpHook", 307 | sizeof(CryptImpHook), 308 | 0, 309 | (destructor)CryptImpHook_dealloc, 310 | 0, 311 | (getattrfunc)CryptImpHook_GetAttr, 312 | 0, 313 | 0, 314 | 0, 315 | 0, 316 | /* the rest are NULLs */ 317 | }; 318 | 319 | // Now, we take care of the module. 320 | ///! CPython constructor 321 | static PyObject * 322 | CryptImpHook_new(self, args) 323 | PyObject *self, *args; 324 | { 325 | PyObject *result = NULL; 326 | result = CryptImpHook_NEW(); 327 | return result; 328 | } 329 | 330 | ///! CPython Module functions 331 | static PyMethodDef methods[] = { 332 | {"CryptImpHook", CryptImpHook_new, METH_VARARGS}, 333 | {NULL, NULL}, 334 | }; 335 | 336 | ///! Module init function 337 | void initCryptImpHook() 338 | { 339 | PyObject *m; 340 | m = Py_InitModule("CryptImpHook", methods); 341 | } 342 | -------------------------------------------------------------------------------- /src/CryptImpHook.h: -------------------------------------------------------------------------------- 1 | /* 2 | * CryptImpHook.h 3 | * 4 | * \date 2011 5 | * \author Jesus Rivero (Neurogeek) , 6 | * 7 | * LGPL-2.1. The license and distribution terms for this file may be 8 | * found in the file LICENSE in this distribution or at 9 | */ 10 | 11 | #ifndef CRYPTIMPHOOK_H_ 12 | #define CRYPTIMPHOOK_H_ 13 | 14 | char qta[] = { 15 | 0x1A, 0x1B, 0xb9, 0x8f, 0xcf, 0x6a, 16 | 0x1A, 0x1B, 0xb9, 0x8f, 0xcf, 0x6a 17 | }; 18 | 19 | 20 | #endif /* CRYPTIMPHOOK_H_ */ 21 | -------------------------------------------------------------------------------- /src/CryptImpHook_Conv.c: -------------------------------------------------------------------------------- 1 | /* 2 | * CryptImpHook_Conv.c 3 | * 4 | * Created on: Jul 16, 2011 5 | * Author: Jesus Rivero (Neurogeek) 6 | * 7 | * 8 | * CryptImpHook_Conv is a program to encrypt a file using a XOR cipher. 9 | * This is part of the CPython CryptImpHook proof-of-concept 10 | * 11 | * LGPL-2.1. The license and distribution terms for this file may be 12 | * found in the file LICENSE in this distribution or at 13 | * 14 | */ 15 | 16 | #include 17 | #include 18 | #include 19 | #include "CryptImpHook.h" 20 | #include "Cipher.h" 21 | 22 | /*! 23 | * \brief Reads a file and creates another one XOR'ing the contents of the first. 24 | * \param in (FILE *) The in file which contents are going to be XOR'red. 25 | * \param out (FILE *) The results are going to be in this file. 26 | * \param key (char *) The key used to XOR. 27 | */ 28 | void encrypt_data(FILE* in, FILE* out, char* key) 29 | { 30 | int idx = 0; 31 | int btoenc; 32 | 33 | while( (btoenc = fgetc(in)) != EOF) 34 | { 35 | fputc(XOR(btoenc, key[idx % strlen(key)]), out); 36 | idx++; 37 | } 38 | } 39 | 40 | int main(int argc, char* argv[]) 41 | { 42 | if (argc != 3) 43 | { 44 | printf("Usage: %s \n", argv[0]); 45 | exit(0); 46 | } 47 | 48 | FILE* in; 49 | FILE* out; 50 | 51 | in = fopen(argv[1], "r"); 52 | out = fopen(argv[2], "w"); 53 | 54 | if (in == NULL) 55 | { 56 | printf("Input file cannot be read.\n"); 57 | exit(0); 58 | } 59 | 60 | if (out == NULL) 61 | { 62 | printf("Output file cannot be written to.\n"); 63 | exit(0); 64 | } 65 | 66 | printf("Encrypting %s\n", argv[1]); 67 | encrypt_data(in, out, qta); 68 | printf("Encrypted data written to %s\n", argv[2]); 69 | 70 | fclose(in); 71 | fclose(out); 72 | 73 | return 0; 74 | } 75 | -------------------------------------------------------------------------------- /test_script.py: -------------------------------------------------------------------------------- 1 | # Test Python module for encryption 2 | 3 | import os 4 | 5 | def some_function(arg1, arg2, arg3): 6 | return arg1 + arg2 + arg3 7 | 8 | class C(object): 9 | def __init__(self, arg1, arg2, arg3): 10 | print some_function(arg1, arg2, arg3) 11 | 12 | -------------------------------------------------------------------------------- /test_script_b.py: -------------------------------------------------------------------------------- 1 | # Test Python module for encryption 2 | 3 | import os 4 | 5 | def some_function_b(arg1, arg2, arg3): 6 | 7 | print arg1 + arg2 + arg3 8 | return arg1 + arg2 + arg3 9 | --------------------------------------------------------------------------------