├── .gitignore ├── CMakeLists.txt ├── LICENSE ├── README.md ├── applications └── CMakeLists.txt ├── cmake ├── fetch-package.cmake ├── half-package.cmake ├── llvm-package.cmake └── rv-package.cmake ├── config-amdgpu.sh.template ├── config.sh.template ├── ctags └── .ctags ├── gdbinit ├── layout └── doxyfile.skeleton ├── patches ├── llvm │ ├── apply.cmake │ └── nvptx_feature.patch ├── pal │ └── cmake-setup.patch ├── rocm-device-libs │ └── target-triple.patch └── runtime │ └── cmake_multiconfig.patch ├── scripts ├── clang-format ├── download_llvm.sh ├── install_ycomp.sh ├── rocm-device-libs-cc-patcher.py ├── setup-path.sh └── setup_vim_projects.sh ├── setup.sh ├── vim ├── .project.vim ├── ftdetect │ ├── impala.vim │ └── thorin.vim └── syntax │ ├── impala.vim │ └── thorin.vim └── zsh └── _artic /.gitignore: -------------------------------------------------------------------------------- 1 | anydsl.github.io/ 2 | artic/ 3 | config.sh 4 | half/ 5 | impala/ 6 | llvm-project/ 7 | llvm_build/ 8 | rv_build/ 9 | llvm_install/ 10 | project.sh 11 | rodent/ 12 | runtime/ 13 | stincilla/ 14 | thorin/ 15 | build* 16 | contrib/ 17 | pal/ 18 | rocm-device-libs/ 19 | CTestConfig.cmake 20 | clang+llvm-*.tar.xz 21 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.20 FATAL_ERROR) 2 | 3 | project(AnyDSL) 4 | 5 | set(AnyDSL_REMOTE_URL "https://github.com/AnyDSL" CACHE STRING "url used by git to checkout AnyDSL packages") 6 | set(AnyDSL_DEFAULT_BRANCH master CACHE STRING "the default branch of thorin, impala, etc.") 7 | message(STATUS "AnyDSL remote url: ${AnyDSL_REMOTE_URL}") 8 | message(STATUS "AnyDSL default branch: ${AnyDSL_DEFAULT_BRANCH}") 9 | 10 | set(AnyDSL_PKG_Half_AUTOBUILD OFF CACHE BOOL "forces the availability of Half to build AnyDSL packages") 11 | set(AnyDSL_PKG_LLVM_AUTOBUILD OFF CACHE BOOL "forces the availability of LLVM to build AnyDSL packages") 12 | set(AnyDSL_PKG_RV_AUTOBUILD OFF CACHE BOOL "forces the availability of RV to build AnyDSL packages") 13 | 14 | # Half 15 | include(cmake/half-package.cmake) 16 | if(Half_DIR) 17 | message(STATUS "Half_DIR: ${Half_DIR}") 18 | else() 19 | message(STATUS "Half not found.") 20 | endif() 21 | 22 | # LLVM and clang 23 | include(cmake/llvm-package.cmake) 24 | include(cmake/rv-package.cmake) 25 | 26 | find_package(LLVM QUIET) 27 | if(LLVM_FOUND) 28 | message(STATUS "LLVM_DIR: ${LLVM_DIR}") 29 | message(STATUS "LLVM_VERSION: ${LLVM_VERSION}") 30 | message(STATUS "LLVM_ENABLE_RTTI: ${LLVM_ENABLE_RTTI}") 31 | message(STATUS "LLVM_LINK_LLVM_DYLIB: ${LLVM_LINK_LLVM_DYLIB}") 32 | else() 33 | message(STATUS "LLVM not found.") 34 | endif() 35 | 36 | 37 | include(cmake/fetch-package.cmake) 38 | 39 | # AnyDSL_thorin 40 | fetch_anydsl_package(AnyDSL_thorin_DIR thorin thorin ${AnyDSL_REMOTE_URL}/thorin) 41 | message(STATUS "AnyDSL_thorin_DIR: ${AnyDSL_thorin_DIR}") 42 | set(Thorin_DIR ${AnyDSL_thorin_DIR}) 43 | # TODO: this actually fixes missing dependency in thorin to include llvm/IR/Attributes.inc 44 | if(TARGET intrinsics_gen) 45 | add_dependencies(thorin intrinsics_gen) 46 | endif() 47 | 48 | 49 | # AnyDSL_impala 50 | fetch_anydsl_package(AnyDSL_impala_DIR impala impala ${AnyDSL_REMOTE_URL}/impala) 51 | message(STATUS "AnyDSL_impala_DIR: ${AnyDSL_impala_DIR}") 52 | set(Impala_DIR ${AnyDSL_impala_DIR}) 53 | 54 | # AnyDSL_artic 55 | fetch_anydsl_package(AnyDSL_artic_DIR artic artic ${AnyDSL_REMOTE_URL}/artic) 56 | message(STATUS "AnyDSL_artic_DIR: ${AnyDSL_artic_DIR}") 57 | set(Artic_DIR ${AnyDSL_artic_DIR}) 58 | 59 | # AnyDSL_runtime 60 | fetch_anydsl_package(AnyDSL_runtime_DIR runtime AnyDSL_runtime ${AnyDSL_REMOTE_URL}/runtime) 61 | message(STATUS "AnyDSL_runtime_DIR: ${AnyDSL_runtime_DIR}") 62 | # this triggers the build of clang that is required for the anydsl_runtime_wrap() macro of the runtime 63 | # TODO: actually clang shall be build for impala/artic as they require further processing of their output 64 | if(TARGET clang) 65 | add_dependencies(runtime clang) 66 | endif() 67 | 68 | 69 | add_custom_target(pull COMMENT ">>> pull all AnyDSL packages") 70 | add_dependencies(pull pull-thorin pull-impala pull-artic pull-runtime) 71 | 72 | add_subdirectory(applications) 73 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AnyDSL 2 | Meta project to quickly build dependencies 3 | 4 | ## Building 5 | 6 | ```bash 7 | git clone https://github.com/AnyDSL/anydsl.git 8 | cd anydsl 9 | cp config.sh.template config.sh 10 | ./setup.sh 11 | ``` 12 | You may also want to fine-tune ```config.sh```. 13 | 14 | See [Build Instructions](https://anydsl.github.io/Build-Instructions.html) for more information. 15 | -------------------------------------------------------------------------------- /applications/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.20 FATAL_ERROR) 2 | 3 | file(GLOB _application_paths "*/CMakeLists.txt") 4 | 5 | foreach(_appfullpath ${_application_paths}) 6 | get_filename_component(_apppath ${_appfullpath} DIRECTORY) 7 | get_filename_component(_appdir ${_apppath} NAME) 8 | 9 | set(_appoption "AnyDSL_BUILD_${_appdir}") 10 | option(${_appoption} OFF) 11 | if(NOT ${_appoption}) 12 | message(STATUS "Found application ${_appdir} (skipped)") 13 | else() 14 | message(STATUS "Build with application ${_appdir}") 15 | add_subdirectory(${_appdir}) 16 | endif() 17 | endforeach() 18 | -------------------------------------------------------------------------------- /cmake/fetch-package.cmake: -------------------------------------------------------------------------------- 1 | function(fetch_anydsl_package _pkg_path _pkg_name _pkg_fullname _pkg_url) 2 | # TODO: make this consistent 3 | # set(_pkg_fullname "AnyDSL_${_pkg_name}") 4 | set(_pkg_branch "AnyDSL_${_pkg_name}_BRANCH") 5 | if(NOT ${_pkg_branch}) 6 | set(${_pkg_branch} ${AnyDSL_DEFAULT_BRANCH} CACHE STRING "follow branch of repository ${_pkg_url}") 7 | endif() 8 | string(TOLOWER ${_pkg_fullname} _pkg_fullname_lower) 9 | find_path(${_pkg_path} 10 | NAMES ${_pkg_fullname}-config.cmake ${_pkg_fullname_lower}-config.cmake 11 | PATHS 12 | ${${_pkg_path}} 13 | $ENV{${_pkg_path}} 14 | ${CMAKE_CURRENT_SOURCE_DIR}/${_pkg_name}/build 15 | ${ARGN} 16 | PATH_SUFFIXES 17 | share/${_pkg_fullname}/cmake 18 | share/anydsl/cmake 19 | ) 20 | find_package(Git REQUIRED) 21 | if(NOT ${_pkg_path} AND NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${_pkg_name}) 22 | execute_process(COMMAND ${GIT_EXECUTABLE} clone --branch ${${_pkg_branch}} --recursive ${_pkg_url} ${_pkg_name} WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) 23 | endif() 24 | add_subdirectory(${_pkg_name}) 25 | find_path(${_pkg_path} 26 | NAMES ${_pkg_fullname}-config.cmake ${_pkg_fullname_lower}-config.cmake 27 | PATHS ${${_pkg_path}} ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_BINARY_DIR} ${ARGN} 28 | PATH_SUFFIXES share/${_pkg_fullname}/cmake share/anydsl/cmake 29 | DOC "path to package ${_pkg_fullname}") 30 | add_custom_target(pull-${_pkg_name} 31 | COMMAND ${GIT_EXECUTABLE} fetch --tags origin 32 | COMMAND ${GIT_EXECUTABLE} checkout ${${_pkg_branch}} 33 | COMMAND ${GIT_EXECUTABLE} symbolic-ref HEAD 34 | COMMAND ${GIT_EXECUTABLE} pull 35 | WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${_pkg_name} 36 | COMMENT ">>> pull ${_pkg_url} ${${_pkg_branch}}" 37 | ) 38 | endfunction() 39 | 40 | -------------------------------------------------------------------------------- /cmake/half-package.cmake: -------------------------------------------------------------------------------- 1 | set(AnyDSL_PKG_Half_VERSION "2.2.0" CACHE STRING "Half version of AnyDSL") 2 | set(AnyDSL_PKG_Half_URL "https://sourceforge.net/projects/half/files/half/${AnyDSL_PKG_Half_VERSION}/half-${AnyDSL_PKG_Half_VERSION}.zip/download" CACHE STRING "where to download Half") 3 | 4 | find_package(Half QUIET) 5 | if(((NOT Half_FOUND) OR AnyDSL_PKG_Half_AUTOBUILD) AND NOT CMAKE_DISABLE_FIND_PACKAGE_Half) 6 | if (NOT AnyDSL_PKG_Half_AUTOBUILD) 7 | message(WARNING 8 | "AnyDSL_PKG_Half_AUTOBUILD was set to OFF, but CMake could not find Half. 9 | We will therefore download it anyways. 10 | To get rid of this warning, either set Half_DIR or enable AnyDSL_PKG_Half_AUTOBUILD.") 11 | endif() 12 | 13 | include(FetchContent) 14 | 15 | FetchContent_Declare(Half 16 | URL ${AnyDSL_PKG_Half_URL} 17 | DOWNLOAD_NAME half.zip 18 | DOWNLOAD_EXTRACT_TIMESTAMP OFF 19 | ) 20 | 21 | message(STATUS "Make Half available ...") 22 | FetchContent_GetProperties(Half) 23 | if(NOT half_POPULATED) 24 | FetchContent_Populate(Half) 25 | endif() 26 | 27 | find_path(Half_DIR half.hpp 28 | PATHS 29 | ${half_SOURCE_DIR} 30 | ${half_BINARY_DIR} 31 | PATH_SUFFIXES 32 | include 33 | include/half 34 | DOC "C++ library for half precision floating point arithmetics." 35 | ) 36 | endif() 37 | -------------------------------------------------------------------------------- /cmake/llvm-package.cmake: -------------------------------------------------------------------------------- 1 | set(AnyDSL_PKG_LLVM_VERSION "18.1.8" CACHE STRING "LLVM version of AnyDSL") 2 | set(AnyDSL_PKG_LLVM_URL "https://github.com/llvm/llvm-project/releases/download/llvmorg-${AnyDSL_PKG_LLVM_VERSION}/llvm-project-${AnyDSL_PKG_LLVM_VERSION}.src.tar.xz" CACHE STRING "where to download LLVM") 3 | 4 | # LLVM's version handling requires exact matches of major.minor to ensure API compatibility 5 | # however, LLVM does not support version ranges for CMake's find_package() command 6 | string(REGEX MATCH "^[0-9]+\.[0-9]+" AnyDSL_PKG_LLVM_VERSION_MAJOR_MINOR ${AnyDSL_PKG_LLVM_VERSION}) 7 | 8 | set(AnyDSL_PKG_LLVM_DIR ${LLVM_DIR}) 9 | find_package(LLVM ${AnyDSL_PKG_LLVM_VERSION_MAJOR_MINOR} CONFIG QUIET) 10 | if (NOT LLVM_FOUND) 11 | set(LLVM_DIR ${AnyDSL_PKG_LLVM_DIR}) 12 | endif() 13 | 14 | if (NOT LLVM_FOUND AND NOT CMAKE_DISABLE_FIND_PACKAGE_LLVM) 15 | find_package(LLVM CONFIG QUIET) 16 | if (NOT LLVM_FOUND) 17 | message(WARNING 18 | "LLVM not found. This is probably not what you want to do. You can either set AnyDSL_PKG_LLVM_AUTOBUILD to ON, or set LLVM_DIR to point to LLVM ${AnyDSL_PKG_LLVM_VERSION}. 19 | You can get also rid of this warning by setting CMAKE_DISABLE_FIND_PACKAGE_LLVM to ON.") 20 | else() 21 | message(WARNING 22 | "LLVM ${LLVM_VERSION} found, but this version does not match what AnyDSL expects. This is probably not what you want to do. You can either set AnyDSL_PKG_LLVM_AUTOBUILD to ON, or set LLVM_DIR to point to LLVM ${AnyDSL_PKG_LLVM_VERSION_MAJOR_MINOR}. 23 | You can also get rid of this warning by setting AnyDSL_PKG_LLVM_VERSION to ${LLVM_VERSION}, or by enabling CMAKE_DISABLE_FIND_PACKAGE_LLVM.") 24 | endif() 25 | endif() 26 | 27 | if(AnyDSL_PKG_LLVM_AUTOBUILD AND NOT CMAKE_DISABLE_FIND_PACKAGE_LLVM) 28 | include(FetchContent) 29 | 30 | FetchContent_Declare(LLVM 31 | URL ${AnyDSL_PKG_LLVM_URL} 32 | PATCH_COMMAND ${CMAKE_COMMAND} -D LLVM_VERSION=${AnyDSL_PKG_LLVM_VERSION} -P ${CMAKE_CURRENT_SOURCE_DIR}/patches/llvm/apply.cmake 33 | DOWNLOAD_EXTRACT_TIMESTAMP OFF 34 | ) 35 | set(LLVM_TARGETS_TO_BUILD "AArch64;AMDGPU;ARM;NVPTX;X86" CACHE STRING "limit targets of LLVM") 36 | set(LLVM_ENABLE_PROJECTS "clang;lld" CACHE STRING "enable projects of LLVM") 37 | set(LLVM_INCLUDE_TESTS OFF) 38 | set(LLVM_ENABLE_RTTI ON) 39 | 40 | message(STATUS "Make LLVM available ...") 41 | FetchContent_GetProperties(LLVM) 42 | 43 | if(NOT llvm_POPULATED) 44 | FetchContent_Populate(LLVM) 45 | endif() 46 | 47 | message(STATUS "llvm_SOURCE_DIR: ${llvm_SOURCE_DIR}") 48 | add_subdirectory(${llvm_SOURCE_DIR}/llvm ${llvm_BINARY_DIR}) 49 | 50 | find_path(LLVM_DIR LLVMConfig.cmake 51 | PATHS 52 | ${llvm_BINARY_DIR} 53 | PATH_SUFFIXES 54 | lib/cmake/llvm 55 | share/llvm/cmake 56 | ) 57 | 58 | find_path(Clang_DIR ClangConfig.cmake 59 | PATHS 60 | ${llvm_BINARY_DIR} 61 | ${CMAKE_BINARY_DIR} 62 | ${CMAKE_CURRENT_BINARY_DIR} 63 | PATH_SUFFIXES 64 | lib/cmake/clang 65 | share/clang/cmake 66 | ) 67 | 68 | set(LLVM_DIR ${llvm_BINARY_DIR}/lib/cmake/llvm) 69 | endif() 70 | -------------------------------------------------------------------------------- /cmake/rv-package.cmake: -------------------------------------------------------------------------------- 1 | set(AnyDSL_PKG_RV_TAG "origin/master" CACHE STRING "LLVM is build with this git tag of RV") 2 | set(AnyDSL_PKG_RV_URL "https://github.com/cdl-saarland/rv" CACHE STRING "where to clone RV") 3 | 4 | if(AnyDSL_PKG_RV_AUTOBUILD) 5 | include(FetchContent) 6 | 7 | FetchContent_Declare(RV 8 | GIT_REPOSITORY ${AnyDSL_PKG_RV_URL} 9 | GIT_TAG ${AnyDSL_PKG_RV_TAG} 10 | GIT_SUBMODULES vecmath/sleef 11 | ) 12 | message(STATUS "Make RV available ...") 13 | FetchContent_GetProperties(RV) 14 | if(NOT rv_POPULATED) 15 | FetchContent_Populate(RV) 16 | endif() 17 | 18 | message(STATUS "rv_SOURCE_DIR: ${rv_SOURCE_DIR}") 19 | add_subdirectory(${rv_SOURCE_DIR} ${rv_BINARY_DIR}) 20 | 21 | find_path(RV_DIR rv-config.cmake 22 | PATHS 23 | ${rv_BINARY_DIR} 24 | ${CMAKE_CURRENT_BINARY_DIR} 25 | ${CMAKE_BINARY_DIR} 26 | PATH_SUFFIXES 27 | share/anydsl/cmake 28 | ) 29 | 30 | #set(RV_DIR ${rv_BINARY_DIR}/share/anydsl/cmake) 31 | 32 | message(STATUS "rv found in ${RV_DIR}") 33 | endif() 34 | -------------------------------------------------------------------------------- /config-amdgpu.sh.template: -------------------------------------------------------------------------------- 1 | # use Debug or Release 2 | : ${BUILD_TYPE:=Debug} 3 | 4 | : ${CMAKE_MAKE:=""} 5 | : ${MAKE:="make -j4"} 6 | 7 | # use this for ninja instead of make 8 | #: ${CMAKE_MAKE:="-G Ninja -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DLLVM_PARALLEL_COMPILE_JOBS=4 -DLLVM_PARALLEL_LINK_JOBS=1"} 9 | #: ${MAKE:="ninja"} 10 | 11 | # set this to true if you don't have a github account 12 | : ${HTTPS:=true} 13 | 14 | # set this to true if you want to download and build the required version of CMake 15 | : ${CMAKE:=false} 16 | : ${BRANCH_CMAKE:=v3.13.4} 17 | 18 | # set this to false if you don't want to build with LLVM 19 | # setting to false is meant to speed up debugging and not recommended for end users 20 | : ${LLVM:=true} 21 | : ${LLVM_TARGETS:="AArch64;AMDGPU;ARM;NVPTX;X86"} 22 | : ${LLVM_GIT:=true} 23 | : ${LLVM_GITHUB_ORG:=RadeonOpenCompute} 24 | : ${LLVM_GIT_BRANCH:=rocm-5.6.1} 25 | : ${LLVM_SRC_VERSION:=16.0.6} 26 | 27 | # PAL 28 | : ${BUILD_PAL:=true} 29 | # we are currently fixed to this particular commit (one behind the head of branch 'dev' at the time of writing) 30 | # due to changes in PAL's PipelineAbiReader that run into asserts when parsing kernel elfs generated by the AMDGPU backend for OS amdpal 31 | : ${PAL_COMMIT:=2de164b431f8a27652e63513ae73338dc512e5bf} 32 | : ${ROCm_GPU_GENERATION:=gfx1100} 33 | 34 | # set this to false if you don't want to build LLVM with RV support 35 | : ${RV:=true} 36 | 37 | # use this to debug thorin hash table performance 38 | : ${THORIN_PROFILE:=false} 39 | 40 | # set this to false if you don't build with LLVM 41 | : ${RUNTIME_JIT:=true} 42 | 43 | # set this to false to hide runtime debug output 44 | : ${RUNTIME_DEBUG_OUTPUT:=true} 45 | 46 | # set the default branches for each repository 47 | : ${BRANCH_ARTIC:=master} 48 | : ${BRANCH_IMPALA:=master} 49 | : ${BRANCH_THORIN:=master} 50 | : ${BRANCH_RV:=master} 51 | : ${BRANCH_RUNTIME:=master} 52 | : ${BRANCH_STINCILLA:=main} 53 | : ${BRANCH_RODENT:=master} 54 | : ${CLONE_RODENT:=false} 55 | -------------------------------------------------------------------------------- /config.sh.template: -------------------------------------------------------------------------------- 1 | # use Debug or Release 2 | : ${BUILD_TYPE:=Debug} 3 | 4 | : ${CMAKE_MAKE:=""} 5 | : ${MAKE:="make -j4"} 6 | 7 | # use this for ninja instead of make 8 | #: ${CMAKE_MAKE:="-G Ninja -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DLLVM_PARALLEL_COMPILE_JOBS=4 -DLLVM_PARALLEL_LINK_JOBS=1"} 9 | #: ${MAKE:="ninja"} 10 | 11 | # set this to true if you don't have a github account 12 | : ${HTTPS:=true} 13 | 14 | # set this to true if you want to download and build the required version of CMake 15 | : ${CMAKE:=false} 16 | : ${BRANCH_CMAKE:=v3.13.4} 17 | 18 | # set this to false if you don't want to build with LLVM 19 | # setting to false is meant to speed up debugging and not recommended for end users 20 | : ${LLVM:=true} 21 | : ${LLVM_TARGETS:="AArch64;AMDGPU;ARM;NVPTX;X86"} 22 | : ${LLVM_GIT:=false} 23 | : ${LLVM_GITHUB_ORG:=llvm} 24 | : ${LLVM_GIT_BRANCH:=release/20.x} 25 | : ${LLVM_SRC_VERSION:=20.1.5} 26 | 27 | # set this to false if you don't want to build LLVM with RV support 28 | : ${RV:=true} 29 | 30 | # use this to debug thorin hash table performance 31 | : ${THORIN_PROFILE:=false} 32 | 33 | # set this to false if you don't build with LLVM 34 | : ${RUNTIME_JIT:=true} 35 | 36 | # set this to false to hide runtime debug output 37 | : ${RUNTIME_DEBUG_OUTPUT:=true} 38 | 39 | # set the default branches for each repository 40 | : ${BRANCH_ARTIC:=master} 41 | : ${BRANCH_IMPALA:=master} 42 | : ${BRANCH_THORIN:=master} 43 | : ${BRANCH_RV:=release/20.x} 44 | : ${BRANCH_RUNTIME:=master} 45 | : ${BRANCH_STINCILLA:=main} 46 | : ${BRANCH_RODENT:=master} 47 | : ${CLONE_RODENT:=false} 48 | -------------------------------------------------------------------------------- /ctags/.ctags: -------------------------------------------------------------------------------- 1 | --langdef=impala 2 | --langmap=impala:.impala 3 | --regex-impala=/^[ \t]*type[ \t]([a-zA-Z0-9_]+)[ \t]*=.+/\1/t,typedef/ 4 | --regex-impala=/^[ \t]*struct[ \t]([a-zA-Z0-9_]+)/\1/s,struct/ 5 | --regex-impala=/^[ \t]*fn[ \t]([a-zA-Z0-9_]+)/\1/f,function/ 6 | --regex-impala=/^[ \t]*let[ \t]+([a-zA-Z0-9_]+)[ \t]*=/\1/c,constant/ 7 | --regex-impala=/^[ \t]*let[ \t]+mut[ \t]+([a-zA-Z0-9_]+)[ \t]*=/\1/v,variable/ 8 | 9 | -------------------------------------------------------------------------------- /gdbinit: -------------------------------------------------------------------------------- 1 | 2 | set print object on 3 | 4 | define td 5 | call $arg0->dump() 6 | end 7 | document td 8 | Dump a Thorin/Impala-dumpable object. 9 | end 10 | 11 | define ttd 12 | call ($arg0)->type()->dump() 13 | end 14 | document ttd 15 | Dump a Thorin/Impala-dumpable object's type. 16 | end 17 | 18 | define tos 19 | call ($arg0)->to_string() 20 | end 21 | document tos 22 | Call to_string on an object. 23 | end 24 | 25 | define ttos 26 | call ($arg0)->type()->to_string() 27 | end 28 | document ttos 29 | Call to_string on the type() of an object. 30 | end 31 | 32 | define wrthorin 33 | call ($arg0).thorin() 34 | call ($arg0).write_thorin($arg1) 35 | end 36 | document wrthorin 37 | Write thorin representation to the file given as argument. 38 | end 39 | -------------------------------------------------------------------------------- /layout/doxyfile.skeleton: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.9.1 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 30 | # could be handy for archiving the generated documentation or if some version 31 | # control system is used. 32 | 33 | PROJECT_NUMBER = 0.3.9 34 | 35 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 36 | # for a project that appears at the top of each page and should give viewer a 37 | # quick idea about the purpose of the project. Keep the description short. 38 | 39 | PROJECT_BRIEF = 40 | 41 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 42 | # in the documentation. The maximum height of the logo should not exceed 55 43 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 44 | # the logo to the output directory. 45 | 46 | PROJECT_LOGO = 47 | 48 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 49 | # into which the generated documentation will be written. If a relative path is 50 | # entered, it will be relative to the location where doxygen was started. If 51 | # left blank the current directory will be used. 52 | 53 | OUTPUT_DIRECTORY = 54 | 55 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 56 | # directories (in 2 levels) under the output directory of each output format and 57 | # will distribute the generated files over these directories. Enabling this 58 | # option can be useful when feeding doxygen a huge amount of source files, where 59 | # putting all generated files in the same directory would otherwise causes 60 | # performance problems for the file system. 61 | # The default value is: NO. 62 | 63 | CREATE_SUBDIRS = NO 64 | 65 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 66 | # characters to appear in the names of generated files. If set to NO, non-ASCII 67 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 68 | # U+3044. 69 | # The default value is: NO. 70 | 71 | ALLOW_UNICODE_NAMES = NO 72 | 73 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 74 | # documentation generated by doxygen is written. Doxygen will use this 75 | # information to generate all constant output in the proper language. 76 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 77 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 78 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 79 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 80 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 81 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 82 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 83 | # Ukrainian and Vietnamese. 84 | # The default value is: English. 85 | 86 | OUTPUT_LANGUAGE = English 87 | 88 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 89 | # descriptions after the members that are listed in the file and class 90 | # documentation (similar to Javadoc). Set to NO to disable this. 91 | # The default value is: YES. 92 | 93 | BRIEF_MEMBER_DESC = YES 94 | 95 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 96 | # description of a member or function before the detailed description 97 | # 98 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 99 | # brief descriptions will be completely suppressed. 100 | # The default value is: YES. 101 | 102 | REPEAT_BRIEF = YES 103 | 104 | # This tag implements a quasi-intelligent brief description abbreviator that is 105 | # used to form the text in various listings. Each string in this list, if found 106 | # as the leading text of the brief description, will be stripped from the text 107 | # and the result, after processing the whole list, is used as the annotated 108 | # text. Otherwise, the brief description is used as-is. If left blank, the 109 | # following values are used ($name is automatically replaced with the name of 110 | # the entity):The $name class, The $name widget, The $name file, is, provides, 111 | # specifies, contains, represents, a, an and the. 112 | 113 | ABBREVIATE_BRIEF = "The $name class" \ 114 | "The $name widget" \ 115 | "The $name file" \ 116 | is \ 117 | provides \ 118 | specifies \ 119 | contains \ 120 | represents \ 121 | a \ 122 | an \ 123 | the 124 | 125 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 126 | # doxygen will generate a detailed section even if there is only a brief 127 | # description. 128 | # The default value is: NO. 129 | 130 | ALWAYS_DETAILED_SEC = NO 131 | 132 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 133 | # inherited members of a class in the documentation of that class as if those 134 | # members were ordinary class members. Constructors, destructors and assignment 135 | # operators of the base classes will not be shown. 136 | # The default value is: NO. 137 | 138 | INLINE_INHERITED_MEMB = NO 139 | 140 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 141 | # before files name in the file list and in the header files. If set to NO the 142 | # shortest path that makes the file name unique will be used 143 | # The default value is: YES. 144 | 145 | FULL_PATH_NAMES = YES 146 | 147 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 148 | # Stripping is only done if one of the specified strings matches the left-hand 149 | # part of the path. The tag can be used to show relative paths in the file list. 150 | # If left blank the directory from which doxygen is run is used as the path to 151 | # strip. 152 | # 153 | # Note that you can specify absolute paths here, but also relative paths, which 154 | # will be relative from the directory where doxygen is started. 155 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 156 | 157 | STRIP_FROM_PATH = src/ 158 | 159 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 160 | # path mentioned in the documentation of a class, which tells the reader which 161 | # header file to include in order to use a class. If left blank only the name of 162 | # the header file containing the class definition is used. Otherwise one should 163 | # specify the list of include paths that are normally passed to the compiler 164 | # using the -I flag. 165 | 166 | STRIP_FROM_INC_PATH = src/ 167 | 168 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 169 | # less readable) file names. This can be useful is your file systems doesn't 170 | # support long names like on DOS, Mac, or CD-ROM. 171 | # The default value is: NO. 172 | 173 | SHORT_NAMES = NO 174 | 175 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 176 | # first line (until the first dot) of a Javadoc-style comment as the brief 177 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 178 | # style comments (thus requiring an explicit @brief command for a brief 179 | # description.) 180 | # The default value is: NO. 181 | 182 | JAVADOC_AUTOBRIEF = YES 183 | 184 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 185 | # line (until the first dot) of a Qt-style comment as the brief description. If 186 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 187 | # requiring an explicit \brief command for a brief description.) 188 | # The default value is: NO. 189 | 190 | QT_AUTOBRIEF = YES 191 | 192 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 193 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 194 | # a brief description. This used to be the default behavior. The new default is 195 | # to treat a multi-line C++ comment block as a detailed description. Set this 196 | # tag to YES if you prefer the old behavior instead. 197 | # 198 | # Note that setting this tag to YES also means that rational rose comments are 199 | # not recognized any more. 200 | # The default value is: NO. 201 | 202 | MULTILINE_CPP_IS_BRIEF = NO 203 | 204 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 205 | # documentation from any documented member that it re-implements. 206 | # The default value is: YES. 207 | 208 | INHERIT_DOCS = YES 209 | 210 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 211 | # page for each member. If set to NO, the documentation of a member will be part 212 | # of the file/class/namespace that contains it. 213 | # The default value is: NO. 214 | 215 | SEPARATE_MEMBER_PAGES = NO 216 | 217 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 218 | # uses this value to replace tabs by spaces in code fragments. 219 | # Minimum value: 1, maximum value: 16, default value: 4. 220 | 221 | TAB_SIZE = 4 222 | 223 | # This tag can be used to specify a number of aliases that act as commands in 224 | # the documentation. An alias has the form: 225 | # name=value 226 | # For example adding 227 | # "sideeffect=@par Side Effects:\n" 228 | # will allow you to put the command \sideeffect (or @sideeffect) in the 229 | # documentation, which will result in a user-defined paragraph with heading 230 | # "Side Effects:". You can put \n's in the value part of an alias to insert 231 | # newlines. 232 | 233 | ALIASES = 234 | 235 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 236 | # A mapping has the form "name=value". For example adding "class=itcl::class" 237 | # will allow you to use the command class in the itcl::class meaning. 238 | 239 | TCL_SUBST = 240 | 241 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 242 | # only. Doxygen will then generate output that is more tailored for C. For 243 | # instance, some of the names that are used will be different. The list of all 244 | # members will be omitted, etc. 245 | # The default value is: NO. 246 | 247 | OPTIMIZE_OUTPUT_FOR_C = NO 248 | 249 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 250 | # Python sources only. Doxygen will then generate output that is more tailored 251 | # for that language. For instance, namespaces will be presented as packages, 252 | # qualified scopes will look different, etc. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_JAVA = NO 256 | 257 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 258 | # sources. Doxygen will then generate output that is tailored for Fortran. 259 | # The default value is: NO. 260 | 261 | OPTIMIZE_FOR_FORTRAN = NO 262 | 263 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 264 | # sources. Doxygen will then generate output that is tailored for VHDL. 265 | # The default value is: NO. 266 | 267 | OPTIMIZE_OUTPUT_VHDL = NO 268 | 269 | # Doxygen selects the parser to use depending on the extension of the files it 270 | # parses. With this tag you can assign which parser to use for a given 271 | # extension. Doxygen has a built-in mapping, but you can override or extend it 272 | # using this tag. The format is ext=language, where ext is a file extension, and 273 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 274 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 275 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 276 | # Fortran. In the later case the parser tries to guess whether the code is fixed 277 | # or free formatted code, this is the default for Fortran type files), VHDL. For 278 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 279 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 280 | # 281 | # Note: For files without extension you can use no_extension as a placeholder. 282 | # 283 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 284 | # the files are not read by doxygen. 285 | 286 | EXTENSION_MAPPING = 287 | 288 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 289 | # according to the Markdown format, which allows for more readable 290 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 291 | # The output of markdown processing is further processed by doxygen, so you can 292 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 293 | # case of backward compatibilities issues. 294 | # The default value is: YES. 295 | 296 | MARKDOWN_SUPPORT = YES 297 | 298 | # When enabled doxygen tries to link words that correspond to documented 299 | # classes, or namespaces to their corresponding documentation. Such a link can 300 | # be prevented in individual cases by putting a % sign in front of the word or 301 | # globally by setting AUTOLINK_SUPPORT to NO. 302 | # The default value is: YES. 303 | 304 | AUTOLINK_SUPPORT = YES 305 | 306 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 307 | # to include (a tag file for) the STL sources as input, then you should set this 308 | # tag to YES in order to let doxygen match functions declarations and 309 | # definitions whose arguments contain STL classes (e.g. func(std::string); 310 | # versus func(std::string) {}). This also make the inheritance and collaboration 311 | # diagrams that involve STL classes more complete and accurate. 312 | # The default value is: NO. 313 | 314 | BUILTIN_STL_SUPPORT = YES 315 | 316 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 317 | # enable parsing support. 318 | # The default value is: NO. 319 | 320 | CPP_CLI_SUPPORT = NO 321 | 322 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 323 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 324 | # will parse them like normal C++ but will assume all classes use public instead 325 | # of private inheritance when no explicit protection keyword is present. 326 | # The default value is: NO. 327 | 328 | SIP_SUPPORT = NO 329 | 330 | # For Microsoft's IDL there are propget and propput attributes to indicate 331 | # getter and setter methods for a property. Setting this option to YES will make 332 | # doxygen to replace the get and set methods by a property in the documentation. 333 | # This will only work if the methods are indeed getting or setting a simple 334 | # type. If this is not the case, or you want to show the methods anyway, you 335 | # should set this option to NO. 336 | # The default value is: YES. 337 | 338 | IDL_PROPERTY_SUPPORT = YES 339 | 340 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 341 | # tag is set to YES then doxygen will reuse the documentation of the first 342 | # member in the group (if any) for the other members of the group. By default 343 | # all members of a group must be documented explicitly. 344 | # The default value is: NO. 345 | 346 | DISTRIBUTE_GROUP_DOC = NO 347 | 348 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 349 | # (for instance a group of public functions) to be put as a subgroup of that 350 | # type (e.g. under the Public Functions section). Set it to NO to prevent 351 | # subgrouping. Alternatively, this can be done per class using the 352 | # \nosubgrouping command. 353 | # The default value is: YES. 354 | 355 | SUBGROUPING = YES 356 | 357 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 358 | # are shown inside the group in which they are included (e.g. using \ingroup) 359 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 360 | # and RTF). 361 | # 362 | # Note that this feature does not work in combination with 363 | # SEPARATE_MEMBER_PAGES. 364 | # The default value is: NO. 365 | 366 | INLINE_GROUPED_CLASSES = NO 367 | 368 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 369 | # with only public data fields or simple typedef fields will be shown inline in 370 | # the documentation of the scope in which they are defined (i.e. file, 371 | # namespace, or group documentation), provided this scope is documented. If set 372 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 373 | # Man pages) or section (for LaTeX and RTF). 374 | # The default value is: NO. 375 | 376 | INLINE_SIMPLE_STRUCTS = NO 377 | 378 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 379 | # enum is documented as struct, union, or enum with the name of the typedef. So 380 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 381 | # with name TypeT. When disabled the typedef will appear as a member of a file, 382 | # namespace, or class. And the struct will be named TypeS. This can typically be 383 | # useful for C code in case the coding convention dictates that all compound 384 | # types are typedef'ed and only the typedef is referenced, never the tag name. 385 | # The default value is: NO. 386 | 387 | TYPEDEF_HIDES_STRUCT = NO 388 | 389 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 390 | # cache is used to resolve symbols given their name and scope. Since this can be 391 | # an expensive process and often the same symbol appears multiple times in the 392 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 393 | # doxygen will become slower. If the cache is too large, memory is wasted. The 394 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 395 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 396 | # symbols. At the end of a run doxygen will report the cache usage and suggest 397 | # the optimal cache size from a speed point of view. 398 | # Minimum value: 0, maximum value: 9, default value: 0. 399 | 400 | LOOKUP_CACHE_SIZE = 0 401 | 402 | #--------------------------------------------------------------------------- 403 | # Build related configuration options 404 | #--------------------------------------------------------------------------- 405 | 406 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 407 | # documentation are documented, even if no documentation was available. Private 408 | # class members and static file members will be hidden unless the 409 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 410 | # Note: This will also disable the warnings about undocumented members that are 411 | # normally produced when WARNINGS is set to YES. 412 | # The default value is: NO. 413 | 414 | EXTRACT_ALL = YES 415 | 416 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 417 | # be included in the documentation. 418 | # The default value is: NO. 419 | 420 | EXTRACT_PRIVATE = NO 421 | 422 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 423 | # scope will be included in the documentation. 424 | # The default value is: NO. 425 | 426 | EXTRACT_PACKAGE = YES 427 | 428 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 429 | # included in the documentation. 430 | # The default value is: NO. 431 | 432 | EXTRACT_STATIC = YES 433 | 434 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 435 | # locally in source files will be included in the documentation. If set to NO, 436 | # only classes defined in header files are included. Does not have any effect 437 | # for Java sources. 438 | # The default value is: YES. 439 | 440 | EXTRACT_LOCAL_CLASSES = YES 441 | 442 | # This flag is only useful for Objective-C code. If set to YES, local methods, 443 | # which are defined in the implementation section but not in the interface are 444 | # included in the documentation. If set to NO, only methods in the interface are 445 | # included. 446 | # The default value is: NO. 447 | 448 | EXTRACT_LOCAL_METHODS = YES 449 | 450 | # If this flag is set to YES, the members of anonymous namespaces will be 451 | # extracted and appear in the documentation as a namespace called 452 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 453 | # the file that contains the anonymous namespace. By default anonymous namespace 454 | # are hidden. 455 | # The default value is: NO. 456 | 457 | EXTRACT_ANON_NSPACES = NO 458 | 459 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 460 | # undocumented members inside documented classes or files. If set to NO these 461 | # members will be included in the various overviews, but no documentation 462 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 463 | # The default value is: NO. 464 | 465 | HIDE_UNDOC_MEMBERS = NO 466 | 467 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 468 | # undocumented classes that are normally visible in the class hierarchy. If set 469 | # to NO, these classes will be included in the various overviews. This option 470 | # has no effect if EXTRACT_ALL is enabled. 471 | # The default value is: NO. 472 | 473 | HIDE_UNDOC_CLASSES = NO 474 | 475 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 476 | # (class|struct|union) declarations. If set to NO, these declarations will be 477 | # included in the documentation. 478 | # The default value is: NO. 479 | 480 | HIDE_FRIEND_COMPOUNDS = NO 481 | 482 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 483 | # documentation blocks found inside the body of a function. If set to NO, these 484 | # blocks will be appended to the function's detailed documentation block. 485 | # The default value is: NO. 486 | 487 | HIDE_IN_BODY_DOCS = NO 488 | 489 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 490 | # \internal command is included. If the tag is set to NO then the documentation 491 | # will be excluded. Set it to YES to include the internal documentation. 492 | # The default value is: NO. 493 | 494 | INTERNAL_DOCS = NO 495 | 496 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 497 | # names in lower-case letters. If set to YES, upper-case letters are also 498 | # allowed. This is useful if you have classes or files whose names only differ 499 | # in case and if your file system supports case sensitive file names. Windows 500 | # and Mac users are advised to set this option to NO. 501 | # The default value is: system dependent. 502 | 503 | CASE_SENSE_NAMES = NO 504 | 505 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 506 | # their full class and namespace scopes in the documentation. If set to YES, the 507 | # scope will be hidden. 508 | # The default value is: NO. 509 | 510 | HIDE_SCOPE_NAMES = NO 511 | 512 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 513 | # append additional text to a page's title, such as Class Reference. If set to 514 | # YES the compound reference will be hidden. 515 | # The default value is: NO. 516 | 517 | HIDE_COMPOUND_REFERENCE= NO 518 | 519 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 520 | # the files that are included by a file in the documentation of that file. 521 | # The default value is: YES. 522 | 523 | SHOW_INCLUDE_FILES = YES 524 | 525 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 526 | # grouped member an include statement to the documentation, telling the reader 527 | # which file to include in order to use the member. 528 | # The default value is: NO. 529 | 530 | SHOW_GROUPED_MEMB_INC = NO 531 | 532 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 533 | # files with double quotes in the documentation rather than with sharp brackets. 534 | # The default value is: NO. 535 | 536 | FORCE_LOCAL_INCLUDES = NO 537 | 538 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 539 | # documentation for inline members. 540 | # The default value is: YES. 541 | 542 | INLINE_INFO = YES 543 | 544 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 545 | # (detailed) documentation of file and class members alphabetically by member 546 | # name. If set to NO, the members will appear in declaration order. 547 | # The default value is: YES. 548 | 549 | SORT_MEMBER_DOCS = YES 550 | 551 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 552 | # descriptions of file, namespace and class members alphabetically by member 553 | # name. If set to NO, the members will appear in declaration order. Note that 554 | # this will also influence the order of the classes in the class list. 555 | # The default value is: NO. 556 | 557 | SORT_BRIEF_DOCS = YES 558 | 559 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 560 | # (brief and detailed) documentation of class members so that constructors and 561 | # destructors are listed first. If set to NO the constructors will appear in the 562 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 563 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 564 | # member documentation. 565 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 566 | # detailed member documentation. 567 | # The default value is: NO. 568 | 569 | SORT_MEMBERS_CTORS_1ST = YES 570 | 571 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 572 | # of group names into alphabetical order. If set to NO the group names will 573 | # appear in their defined order. 574 | # The default value is: NO. 575 | 576 | SORT_GROUP_NAMES = NO 577 | 578 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 579 | # fully-qualified names, including namespaces. If set to NO, the class list will 580 | # be sorted only by class name, not including the namespace part. 581 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 582 | # Note: This option applies only to the class list, not to the alphabetical 583 | # list. 584 | # The default value is: NO. 585 | 586 | SORT_BY_SCOPE_NAME = YES 587 | 588 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 589 | # type resolution of all parameters of a function it will reject a match between 590 | # the prototype and the implementation of a member function even if there is 591 | # only one candidate or it is obvious which candidate to choose by doing a 592 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 593 | # accept a match between prototype and implementation in such cases. 594 | # The default value is: NO. 595 | 596 | STRICT_PROTO_MATCHING = NO 597 | 598 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 599 | # list. This list is created by putting \todo commands in the documentation. 600 | # The default value is: YES. 601 | 602 | GENERATE_TODOLIST = YES 603 | 604 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 605 | # list. This list is created by putting \test commands in the documentation. 606 | # The default value is: YES. 607 | 608 | GENERATE_TESTLIST = YES 609 | 610 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 611 | # list. This list is created by putting \bug commands in the documentation. 612 | # The default value is: YES. 613 | 614 | GENERATE_BUGLIST = YES 615 | 616 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 617 | # the deprecated list. This list is created by putting \deprecated commands in 618 | # the documentation. 619 | # The default value is: YES. 620 | 621 | GENERATE_DEPRECATEDLIST= YES 622 | 623 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 624 | # sections, marked by \if ... \endif and \cond 625 | # ... \endcond blocks. 626 | 627 | ENABLED_SECTIONS = 628 | 629 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 630 | # initial value of a variable or macro / define can have for it to appear in the 631 | # documentation. If the initializer consists of more lines than specified here 632 | # it will be hidden. Use a value of 0 to hide initializers completely. The 633 | # appearance of the value of individual variables and macros / defines can be 634 | # controlled using \showinitializer or \hideinitializer command in the 635 | # documentation regardless of this setting. 636 | # Minimum value: 0, maximum value: 10000, default value: 30. 637 | 638 | MAX_INITIALIZER_LINES = 30 639 | 640 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 641 | # the bottom of the documentation of classes and structs. If set to YES, the 642 | # list will mention the files that were used to generate the documentation. 643 | # The default value is: YES. 644 | 645 | SHOW_USED_FILES = YES 646 | 647 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 648 | # will remove the Files entry from the Quick Index and from the Folder Tree View 649 | # (if specified). 650 | # The default value is: YES. 651 | 652 | SHOW_FILES = YES 653 | 654 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 655 | # page. This will remove the Namespaces entry from the Quick Index and from the 656 | # Folder Tree View (if specified). 657 | # The default value is: YES. 658 | 659 | SHOW_NAMESPACES = YES 660 | 661 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 662 | # doxygen should invoke to get the current version for each file (typically from 663 | # the version control system). Doxygen will invoke the program by executing (via 664 | # popen()) the command command input-file, where command is the value of the 665 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 666 | # by doxygen. Whatever the program writes to standard output is used as the file 667 | # version. For an example see the documentation. 668 | 669 | FILE_VERSION_FILTER = 670 | 671 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 672 | # by doxygen. The layout file controls the global structure of the generated 673 | # output files in an output format independent way. To create the layout file 674 | # that represents doxygen's defaults, run doxygen with the -l option. You can 675 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 676 | # will be used as the name of the layout file. 677 | # 678 | # Note that if you run doxygen from a directory containing a file called 679 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 680 | # tag is left empty. 681 | 682 | LAYOUT_FILE = 683 | 684 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 685 | # the reference definitions. This must be a list of .bib files. The .bib 686 | # extension is automatically appended if omitted. This requires the bibtex tool 687 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 688 | # For LaTeX the style of the bibliography can be controlled using 689 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 690 | # search path. See also \cite for info how to create references. 691 | 692 | CITE_BIB_FILES = 693 | 694 | #--------------------------------------------------------------------------- 695 | # Configuration options related to warning and progress messages 696 | #--------------------------------------------------------------------------- 697 | 698 | # The QUIET tag can be used to turn on/off the messages that are generated to 699 | # standard output by doxygen. If QUIET is set to YES this implies that the 700 | # messages are off. 701 | # The default value is: NO. 702 | 703 | QUIET = NO 704 | 705 | # The WARNINGS tag can be used to turn on/off the warning messages that are 706 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 707 | # this implies that the warnings are on. 708 | # 709 | # Tip: Turn warnings on while writing the documentation. 710 | # The default value is: YES. 711 | 712 | WARNINGS = YES 713 | 714 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 715 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 716 | # will automatically be disabled. 717 | # The default value is: YES. 718 | 719 | WARN_IF_UNDOCUMENTED = YES 720 | 721 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 722 | # potential errors in the documentation, such as not documenting some parameters 723 | # in a documented function, or documenting parameters that don't exist or using 724 | # markup commands wrongly. 725 | # The default value is: YES. 726 | 727 | WARN_IF_DOC_ERROR = YES 728 | 729 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 730 | # are documented, but have no documentation for their parameters or return 731 | # value. If set to NO, doxygen will only warn about wrong or incomplete 732 | # parameter documentation, but not about the absence of documentation. 733 | # The default value is: NO. 734 | 735 | WARN_NO_PARAMDOC = NO 736 | 737 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 738 | # can produce. The string should contain the $file, $line, and $text tags, which 739 | # will be replaced by the file and line number from which the warning originated 740 | # and the warning text. Optionally the format may contain $version, which will 741 | # be replaced by the version of the file (if it could be obtained via 742 | # FILE_VERSION_FILTER) 743 | # The default value is: $file:$line: $text. 744 | 745 | WARN_FORMAT = "$file:$line: $text" 746 | 747 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 748 | # messages should be written. If left blank the output is written to standard 749 | # error (stderr). 750 | 751 | WARN_LOGFILE = 752 | 753 | #--------------------------------------------------------------------------- 754 | # Configuration options related to the input files 755 | #--------------------------------------------------------------------------- 756 | 757 | # The INPUT tag is used to specify the files and/or directories that contain 758 | # documented source files. You may enter file names like myfile.cpp or 759 | # directories like /usr/src/myproject. Separate the files or directories with 760 | # spaces. 761 | # Note: If this tag is empty the current directory is searched. 762 | 763 | INPUT = src/ 764 | 765 | # This tag can be used to specify the character encoding of the source files 766 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 767 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 768 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 769 | # possible encodings. 770 | # The default value is: UTF-8. 771 | 772 | INPUT_ENCODING = UTF-8 773 | 774 | # If the value of the INPUT tag contains directories, you can use the 775 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 776 | # *.h) to filter out the source-files in the directories. If left blank the 777 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 778 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 779 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 780 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 781 | # *.qsf, *.as and *.js. 782 | 783 | FILE_PATTERNS = *.c \ 784 | *.cc \ 785 | *.cxx \ 786 | *.cpp \ 787 | *.c++ \ 788 | *.d \ 789 | *.java \ 790 | *.ii \ 791 | *.ixx \ 792 | *.ipp \ 793 | *.i++ \ 794 | *.inl \ 795 | *.h \ 796 | *.hh \ 797 | *.hxx \ 798 | *.hpp \ 799 | *.h++ \ 800 | *.idl \ 801 | *.odl \ 802 | *.cs \ 803 | *.php \ 804 | *.php3 \ 805 | *.inc \ 806 | *.m \ 807 | *.mm \ 808 | *.dox \ 809 | *.py \ 810 | *.f90 \ 811 | *.f \ 812 | *.vhd \ 813 | *.vhdl 814 | 815 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 816 | # be searched for input files as well. 817 | # The default value is: NO. 818 | 819 | RECURSIVE = YES 820 | 821 | # The EXCLUDE tag can be used to specify files and/or directories that should be 822 | # excluded from the INPUT source files. This way you can easily exclude a 823 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 824 | # 825 | # Note that relative paths are relative to the directory from which doxygen is 826 | # run. 827 | 828 | EXCLUDE = 829 | 830 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 831 | # directories that are symbolic links (a Unix file system feature) are excluded 832 | # from the input. 833 | # The default value is: NO. 834 | 835 | EXCLUDE_SYMLINKS = NO 836 | 837 | # If the value of the INPUT tag contains directories, you can use the 838 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 839 | # certain files from those directories. 840 | # 841 | # Note that the wildcards are matched against the file with absolute path, so to 842 | # exclude all test directories for example use the pattern */test/* 843 | 844 | EXCLUDE_PATTERNS = 845 | 846 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 847 | # (namespaces, classes, functions, etc.) that should be excluded from the 848 | # output. The symbol name can be a fully qualified name, a word, or if the 849 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 850 | # AClass::ANamespace, ANamespace::*Test 851 | # 852 | # Note that the wildcards are matched against the file with absolute path, so to 853 | # exclude all test directories use the pattern */test/* 854 | 855 | EXCLUDE_SYMBOLS = 856 | 857 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 858 | # that contain example code fragments that are included (see the \include 859 | # command). 860 | 861 | EXAMPLE_PATH = 862 | 863 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 864 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 865 | # *.h) to filter out the source-files in the directories. If left blank all 866 | # files are included. 867 | 868 | EXAMPLE_PATTERNS = * 869 | 870 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 871 | # searched for input files to be used with the \include or \dontinclude commands 872 | # irrespective of the value of the RECURSIVE tag. 873 | # The default value is: NO. 874 | 875 | EXAMPLE_RECURSIVE = NO 876 | 877 | # The IMAGE_PATH tag can be used to specify one or more files or directories 878 | # that contain images that are to be included in the documentation (see the 879 | # \image command). 880 | 881 | IMAGE_PATH = 882 | 883 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 884 | # invoke to filter for each input file. Doxygen will invoke the filter program 885 | # by executing (via popen()) the command: 886 | # 887 | # 888 | # 889 | # where is the value of the INPUT_FILTER tag, and is the 890 | # name of an input file. Doxygen will then use the output that the filter 891 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 892 | # will be ignored. 893 | # 894 | # Note that the filter must not add or remove lines; it is applied before the 895 | # code is scanned, but not when the output code is generated. If lines are added 896 | # or removed, the anchors will not be placed correctly. 897 | 898 | INPUT_FILTER = 899 | 900 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 901 | # basis. Doxygen will compare the file name with each pattern and apply the 902 | # filter if there is a match. The filters are a list of the form: pattern=filter 903 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 904 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 905 | # patterns match the file name, INPUT_FILTER is applied. 906 | 907 | FILTER_PATTERNS = 908 | 909 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 910 | # INPUT_FILTER) will also be used to filter the input files that are used for 911 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 912 | # The default value is: NO. 913 | 914 | FILTER_SOURCE_FILES = NO 915 | 916 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 917 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 918 | # it is also possible to disable source filtering for a specific pattern using 919 | # *.ext= (so without naming a filter). 920 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 921 | 922 | FILTER_SOURCE_PATTERNS = 923 | 924 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 925 | # is part of the input, its contents will be placed on the main page 926 | # (index.html). This can be useful if you have a project on for instance GitHub 927 | # and want to reuse the introduction page also for the doxygen output. 928 | 929 | USE_MDFILE_AS_MAINPAGE = 930 | 931 | #--------------------------------------------------------------------------- 932 | # Configuration options related to source browsing 933 | #--------------------------------------------------------------------------- 934 | 935 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 936 | # generated. Documented entities will be cross-referenced with these sources. 937 | # 938 | # Note: To get rid of all source code in the generated output, make sure that 939 | # also VERBATIM_HEADERS is set to NO. 940 | # The default value is: NO. 941 | 942 | SOURCE_BROWSER = NO 943 | 944 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 945 | # classes and enums directly into the documentation. 946 | # The default value is: NO. 947 | 948 | INLINE_SOURCES = NO 949 | 950 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 951 | # special comment blocks from generated source code fragments. Normal C, C++ and 952 | # Fortran comments will always remain visible. 953 | # The default value is: YES. 954 | 955 | STRIP_CODE_COMMENTS = YES 956 | 957 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 958 | # function all documented functions referencing it will be listed. 959 | # The default value is: NO. 960 | 961 | REFERENCED_BY_RELATION = NO 962 | 963 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 964 | # all documented entities called/used by that function will be listed. 965 | # The default value is: NO. 966 | 967 | REFERENCES_RELATION = NO 968 | 969 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 970 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 971 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 972 | # link to the documentation. 973 | # The default value is: YES. 974 | 975 | REFERENCES_LINK_SOURCE = YES 976 | 977 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 978 | # source code will show a tooltip with additional information such as prototype, 979 | # brief description and links to the definition and documentation. Since this 980 | # will make the HTML file larger and loading of large files a bit slower, you 981 | # can opt to disable this feature. 982 | # The default value is: YES. 983 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 984 | 985 | SOURCE_TOOLTIPS = YES 986 | 987 | # If the USE_HTAGS tag is set to YES then the references to source code will 988 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 989 | # source browser. The htags tool is part of GNU's global source tagging system 990 | # (see http://www.gnu.org/software/global/global.html). You will need version 991 | # 4.8.6 or higher. 992 | # 993 | # To use it do the following: 994 | # - Install the latest version of global 995 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 996 | # - Make sure the INPUT points to the root of the source tree 997 | # - Run doxygen as normal 998 | # 999 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1000 | # tools must be available from the command line (i.e. in the search path). 1001 | # 1002 | # The result: instead of the source browser generated by doxygen, the links to 1003 | # source code will now point to the output of htags. 1004 | # The default value is: NO. 1005 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1006 | 1007 | USE_HTAGS = NO 1008 | 1009 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1010 | # verbatim copy of the header file for each class for which an include is 1011 | # specified. Set to NO to disable this. 1012 | # See also: Section \class. 1013 | # The default value is: YES. 1014 | 1015 | VERBATIM_HEADERS = NO 1016 | 1017 | #--------------------------------------------------------------------------- 1018 | # Configuration options related to the alphabetical class index 1019 | #--------------------------------------------------------------------------- 1020 | 1021 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1022 | # compounds will be generated. Enable this if the project contains a lot of 1023 | # classes, structs, unions or interfaces. 1024 | # The default value is: YES. 1025 | 1026 | ALPHABETICAL_INDEX = YES 1027 | 1028 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1029 | # which the alphabetical index list will be split. 1030 | # Minimum value: 1, maximum value: 20, default value: 5. 1031 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1032 | 1033 | COLS_IN_ALPHA_INDEX = 1 1034 | 1035 | # In case all classes in a project start with a common prefix, all classes will 1036 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1037 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1038 | # while generating the index headers. 1039 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1040 | 1041 | IGNORE_PREFIX = 1042 | 1043 | #--------------------------------------------------------------------------- 1044 | # Configuration options related to the HTML output 1045 | #--------------------------------------------------------------------------- 1046 | 1047 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1048 | # The default value is: YES. 1049 | 1050 | GENERATE_HTML = YES 1051 | 1052 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1053 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1054 | # it. 1055 | # The default directory is: html. 1056 | # This tag requires that the tag GENERATE_HTML is set to YES. 1057 | 1058 | HTML_OUTPUT = html 1059 | 1060 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1061 | # generated HTML page (for example: .htm, .php, .asp). 1062 | # The default value is: .html. 1063 | # This tag requires that the tag GENERATE_HTML is set to YES. 1064 | 1065 | HTML_FILE_EXTENSION = .html 1066 | 1067 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1068 | # each generated HTML page. If the tag is left blank doxygen will generate a 1069 | # standard header. 1070 | # 1071 | # To get valid HTML the header file that includes any scripts and style sheets 1072 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1073 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1074 | # default header using 1075 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1076 | # YourConfigFile 1077 | # and then modify the file new_header.html. See also section "Doxygen usage" 1078 | # for information on how to generate the default header that doxygen normally 1079 | # uses. 1080 | # Note: The header is subject to change so you typically have to regenerate the 1081 | # default header when upgrading to a newer version of doxygen. For a description 1082 | # of the possible markers and block names see the documentation. 1083 | # This tag requires that the tag GENERATE_HTML is set to YES. 1084 | 1085 | HTML_HEADER = 1086 | 1087 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1088 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1089 | # footer. See HTML_HEADER for more information on how to generate a default 1090 | # footer and what special commands can be used inside the footer. See also 1091 | # section "Doxygen usage" for information on how to generate the default footer 1092 | # that doxygen normally uses. 1093 | # This tag requires that the tag GENERATE_HTML is set to YES. 1094 | 1095 | HTML_FOOTER = 1096 | 1097 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1098 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1099 | # the HTML output. If left blank doxygen will generate a default style sheet. 1100 | # See also section "Doxygen usage" for information on how to generate the style 1101 | # sheet that doxygen normally uses. 1102 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1103 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1104 | # obsolete. 1105 | # This tag requires that the tag GENERATE_HTML is set to YES. 1106 | 1107 | HTML_STYLESHEET = 1108 | 1109 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1110 | # cascading style sheets that are included after the standard style sheets 1111 | # created by doxygen. Using this option one can overrule certain style aspects. 1112 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1113 | # standard style sheet and is therefore more robust against future updates. 1114 | # Doxygen will copy the style sheet files to the output directory. 1115 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1116 | # style sheet in the list overrules the setting of the previous ones in the 1117 | # list). For an example see the documentation. 1118 | # This tag requires that the tag GENERATE_HTML is set to YES. 1119 | 1120 | HTML_EXTRA_STYLESHEET = 1121 | 1122 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1123 | # other source files which should be copied to the HTML output directory. Note 1124 | # that these files will be copied to the base HTML output directory. Use the 1125 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1126 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1127 | # files will be copied as-is; there are no commands or markers available. 1128 | # This tag requires that the tag GENERATE_HTML is set to YES. 1129 | 1130 | HTML_EXTRA_FILES = 1131 | 1132 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1133 | # will adjust the colors in the style sheet and background images according to 1134 | # this color. Hue is specified as an angle on a colorwheel, see 1135 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1136 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1137 | # purple, and 360 is red again. 1138 | # Minimum value: 0, maximum value: 359, default value: 220. 1139 | # This tag requires that the tag GENERATE_HTML is set to YES. 1140 | 1141 | HTML_COLORSTYLE_HUE = 220 1142 | 1143 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1144 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1145 | # value of 255 will produce the most vivid colors. 1146 | # Minimum value: 0, maximum value: 255, default value: 100. 1147 | # This tag requires that the tag GENERATE_HTML is set to YES. 1148 | 1149 | HTML_COLORSTYLE_SAT = 100 1150 | 1151 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1152 | # luminance component of the colors in the HTML output. Values below 100 1153 | # gradually make the output lighter, whereas values above 100 make the output 1154 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1155 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1156 | # change the gamma. 1157 | # Minimum value: 40, maximum value: 240, default value: 80. 1158 | # This tag requires that the tag GENERATE_HTML is set to YES. 1159 | 1160 | HTML_COLORSTYLE_GAMMA = 80 1161 | 1162 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1163 | # page will contain the date and time when the page was generated. Setting this 1164 | # to NO can help when comparing the output of multiple runs. 1165 | # The default value is: YES. 1166 | # This tag requires that the tag GENERATE_HTML is set to YES. 1167 | 1168 | HTML_TIMESTAMP = YES 1169 | 1170 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1171 | # documentation will contain sections that can be hidden and shown after the 1172 | # page has loaded. 1173 | # The default value is: NO. 1174 | # This tag requires that the tag GENERATE_HTML is set to YES. 1175 | 1176 | HTML_DYNAMIC_SECTIONS = NO 1177 | 1178 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1179 | # shown in the various tree structured indices initially; the user can expand 1180 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1181 | # such a level that at most the specified number of entries are visible (unless 1182 | # a fully collapsed tree already exceeds this amount). So setting the number of 1183 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1184 | # representing an infinite number of entries and will result in a full expanded 1185 | # tree by default. 1186 | # Minimum value: 0, maximum value: 9999, default value: 100. 1187 | # This tag requires that the tag GENERATE_HTML is set to YES. 1188 | 1189 | HTML_INDEX_NUM_ENTRIES = 0 1190 | 1191 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1192 | # generated that can be used as input for Apple's Xcode 3 integrated development 1193 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1194 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1195 | # Makefile in the HTML output directory. Running make will produce the docset in 1196 | # that directory and running make install will install the docset in 1197 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1198 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1199 | # for more information. 1200 | # The default value is: NO. 1201 | # This tag requires that the tag GENERATE_HTML is set to YES. 1202 | 1203 | GENERATE_DOCSET = NO 1204 | 1205 | # This tag determines the name of the docset feed. A documentation feed provides 1206 | # an umbrella under which multiple documentation sets from a single provider 1207 | # (such as a company or product suite) can be grouped. 1208 | # The default value is: Doxygen generated docs. 1209 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1210 | 1211 | DOCSET_FEEDNAME = "Doxygen generated docs" 1212 | 1213 | # This tag specifies a string that should uniquely identify the documentation 1214 | # set bundle. This should be a reverse domain-name style string, e.g. 1215 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1216 | # The default value is: org.doxygen.Project. 1217 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1218 | 1219 | DOCSET_BUNDLE_ID = org.doxygen.Project 1220 | 1221 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1222 | # the documentation publisher. This should be a reverse domain-name style 1223 | # string, e.g. com.mycompany.MyDocSet.documentation. 1224 | # The default value is: org.doxygen.Publisher. 1225 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1226 | 1227 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1228 | 1229 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1230 | # The default value is: Publisher. 1231 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1232 | 1233 | DOCSET_PUBLISHER_NAME = Publisher 1234 | 1235 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1236 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1237 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1238 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1239 | # Windows. 1240 | # 1241 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1242 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1243 | # files are now used as the Windows 98 help format, and will replace the old 1244 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1245 | # HTML files also contain an index, a table of contents, and you can search for 1246 | # words in the documentation. The HTML workshop also contains a viewer for 1247 | # compressed HTML files. 1248 | # The default value is: NO. 1249 | # This tag requires that the tag GENERATE_HTML is set to YES. 1250 | 1251 | GENERATE_HTMLHELP = NO 1252 | 1253 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1254 | # file. You can add a path in front of the file if the result should not be 1255 | # written to the html output directory. 1256 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1257 | 1258 | CHM_FILE = 1259 | 1260 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1261 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1262 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1263 | # The file has to be specified with full path. 1264 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1265 | 1266 | HHC_LOCATION = 1267 | 1268 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1269 | # (YES) or that it should be included in the master .chm file (NO). 1270 | # The default value is: NO. 1271 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1272 | 1273 | GENERATE_CHI = NO 1274 | 1275 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1276 | # and project file content. 1277 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1278 | 1279 | CHM_INDEX_ENCODING = 1280 | 1281 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1282 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1283 | # enables the Previous and Next buttons. 1284 | # The default value is: NO. 1285 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1286 | 1287 | BINARY_TOC = NO 1288 | 1289 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1290 | # the table of contents of the HTML help documentation and to the tree view. 1291 | # The default value is: NO. 1292 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1293 | 1294 | TOC_EXPAND = YES 1295 | 1296 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1297 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1298 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1299 | # (.qch) of the generated HTML documentation. 1300 | # The default value is: NO. 1301 | # This tag requires that the tag GENERATE_HTML is set to YES. 1302 | 1303 | GENERATE_QHP = NO 1304 | 1305 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1306 | # the file name of the resulting .qch file. The path specified is relative to 1307 | # the HTML output folder. 1308 | # This tag requires that the tag GENERATE_QHP is set to YES. 1309 | 1310 | QCH_FILE = 1311 | 1312 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1313 | # Project output. For more information please see Qt Help Project / Namespace 1314 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1315 | # The default value is: org.doxygen.Project. 1316 | # This tag requires that the tag GENERATE_QHP is set to YES. 1317 | 1318 | QHP_NAMESPACE = org.doxygen.Project 1319 | 1320 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1321 | # Help Project output. For more information please see Qt Help Project / Virtual 1322 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1323 | # folders). 1324 | # The default value is: doc. 1325 | # This tag requires that the tag GENERATE_QHP is set to YES. 1326 | 1327 | QHP_VIRTUAL_FOLDER = doc 1328 | 1329 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1330 | # filter to add. For more information please see Qt Help Project / Custom 1331 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1332 | # filters). 1333 | # This tag requires that the tag GENERATE_QHP is set to YES. 1334 | 1335 | QHP_CUST_FILTER_NAME = 1336 | 1337 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1338 | # custom filter to add. For more information please see Qt Help Project / Custom 1339 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1340 | # filters). 1341 | # This tag requires that the tag GENERATE_QHP is set to YES. 1342 | 1343 | QHP_CUST_FILTER_ATTRS = 1344 | 1345 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1346 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1347 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1348 | # This tag requires that the tag GENERATE_QHP is set to YES. 1349 | 1350 | QHP_SECT_FILTER_ATTRS = 1351 | 1352 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1353 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1354 | # generated .qhp file. 1355 | # This tag requires that the tag GENERATE_QHP is set to YES. 1356 | 1357 | QHG_LOCATION = 1358 | 1359 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1360 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1361 | # install this plugin and make it available under the help contents menu in 1362 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1363 | # to be copied into the plugins directory of eclipse. The name of the directory 1364 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1365 | # After copying Eclipse needs to be restarted before the help appears. 1366 | # The default value is: NO. 1367 | # This tag requires that the tag GENERATE_HTML is set to YES. 1368 | 1369 | GENERATE_ECLIPSEHELP = NO 1370 | 1371 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1372 | # the directory name containing the HTML and XML files should also have this 1373 | # name. Each documentation set should have its own identifier. 1374 | # The default value is: org.doxygen.Project. 1375 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1376 | 1377 | ECLIPSE_DOC_ID = org.doxygen.Project 1378 | 1379 | # If you want full control over the layout of the generated HTML pages it might 1380 | # be necessary to disable the index and replace it with your own. The 1381 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1382 | # of each HTML page. A value of NO enables the index and the value YES disables 1383 | # it. Since the tabs in the index contain the same information as the navigation 1384 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1385 | # The default value is: NO. 1386 | # This tag requires that the tag GENERATE_HTML is set to YES. 1387 | 1388 | DISABLE_INDEX = NO 1389 | 1390 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1391 | # structure should be generated to display hierarchical information. If the tag 1392 | # value is set to YES, a side panel will be generated containing a tree-like 1393 | # index structure (just like the one that is generated for HTML Help). For this 1394 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1395 | # (i.e. any modern browser). Windows users are probably better off using the 1396 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1397 | # further fine-tune the look of the index. As an example, the default style 1398 | # sheet generated by doxygen has an example that shows how to put an image at 1399 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1400 | # the same information as the tab index, you could consider setting 1401 | # DISABLE_INDEX to YES when enabling this option. 1402 | # The default value is: NO. 1403 | # This tag requires that the tag GENERATE_HTML is set to YES. 1404 | 1405 | GENERATE_TREEVIEW = NO 1406 | 1407 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1408 | # doxygen will group on one line in the generated HTML documentation. 1409 | # 1410 | # Note that a value of 0 will completely suppress the enum values from appearing 1411 | # in the overview section. 1412 | # Minimum value: 0, maximum value: 20, default value: 4. 1413 | # This tag requires that the tag GENERATE_HTML is set to YES. 1414 | 1415 | ENUM_VALUES_PER_LINE = 4 1416 | 1417 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1418 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1419 | # Minimum value: 0, maximum value: 1500, default value: 250. 1420 | # This tag requires that the tag GENERATE_HTML is set to YES. 1421 | 1422 | TREEVIEW_WIDTH = 250 1423 | 1424 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1425 | # external symbols imported via tag files in a separate window. 1426 | # The default value is: NO. 1427 | # This tag requires that the tag GENERATE_HTML is set to YES. 1428 | 1429 | EXT_LINKS_IN_WINDOW = NO 1430 | 1431 | # Use this tag to change the font size of LaTeX formulas included as images in 1432 | # the HTML documentation. When you change the font size after a successful 1433 | # doxygen run you need to manually remove any form_*.png images from the HTML 1434 | # output directory to force them to be regenerated. 1435 | # Minimum value: 8, maximum value: 50, default value: 10. 1436 | # This tag requires that the tag GENERATE_HTML is set to YES. 1437 | 1438 | FORMULA_FONTSIZE = 10 1439 | 1440 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1441 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1442 | # supported properly for IE 6.0, but are supported on all modern browsers. 1443 | # 1444 | # Note that when changing this option you need to delete any form_*.png files in 1445 | # the HTML output directory before the changes have effect. 1446 | # The default value is: YES. 1447 | # This tag requires that the tag GENERATE_HTML is set to YES. 1448 | 1449 | FORMULA_TRANSPARENT = YES 1450 | 1451 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1452 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1453 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1454 | # installed or if you want to formulas look prettier in the HTML output. When 1455 | # enabled you may also need to install MathJax separately and configure the path 1456 | # to it using the MATHJAX_RELPATH option. 1457 | # The default value is: NO. 1458 | # This tag requires that the tag GENERATE_HTML is set to YES. 1459 | 1460 | USE_MATHJAX = NO 1461 | 1462 | # When MathJax is enabled you can set the default output format to be used for 1463 | # the MathJax output. See the MathJax site (see: 1464 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1465 | # Possible values are: HTML-CSS (which is slower, but has the best 1466 | # compatibility), NativeMML (i.e. MathML) and SVG. 1467 | # The default value is: HTML-CSS. 1468 | # This tag requires that the tag USE_MATHJAX is set to YES. 1469 | 1470 | MATHJAX_FORMAT = HTML-CSS 1471 | 1472 | # When MathJax is enabled you need to specify the location relative to the HTML 1473 | # output directory using the MATHJAX_RELPATH option. The destination directory 1474 | # should contain the MathJax.js script. For instance, if the mathjax directory 1475 | # is located at the same level as the HTML output directory, then 1476 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1477 | # Content Delivery Network so you can quickly see the result without installing 1478 | # MathJax. However, it is strongly recommended to install a local copy of 1479 | # MathJax from http://www.mathjax.org before deployment. 1480 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1481 | # This tag requires that the tag USE_MATHJAX is set to YES. 1482 | 1483 | MATHJAX_RELPATH = http://www.mathjax.org/mathjax 1484 | 1485 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1486 | # extension names that should be enabled during MathJax rendering. For example 1487 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1488 | # This tag requires that the tag USE_MATHJAX is set to YES. 1489 | 1490 | MATHJAX_EXTENSIONS = 1491 | 1492 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1493 | # of code that will be used on startup of the MathJax code. See the MathJax site 1494 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1495 | # example see the documentation. 1496 | # This tag requires that the tag USE_MATHJAX is set to YES. 1497 | 1498 | MATHJAX_CODEFILE = 1499 | 1500 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1501 | # the HTML output. The underlying search engine uses javascript and DHTML and 1502 | # should work on any modern browser. Note that when using HTML help 1503 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1504 | # there is already a search function so this one should typically be disabled. 1505 | # For large projects the javascript based search engine can be slow, then 1506 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1507 | # search using the keyboard; to jump to the search box use + S 1508 | # (what the is depends on the OS and browser, but it is typically 1509 | # , /