├── .gitignore ├── LICENSE ├── README.md ├── config_gen.py ├── fake-toolchain └── Unix │ ├── ar │ ├── as │ ├── cc │ ├── clang │ ├── clang++ │ ├── cxx │ ├── g++ │ ├── gcc │ ├── gcc++ │ ├── ld │ ├── nm │ └── true ├── plugin └── ycm-generator.vim └── template.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | lib/ 17 | lib64/ 18 | parts/ 19 | sdist/ 20 | var/ 21 | *.egg-info/ 22 | .installed.cfg 23 | *.egg 24 | 25 | # PyInstaller 26 | # Usually these files are written by a python script from a template 27 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 28 | *.manifest 29 | *.spec 30 | 31 | # Installer logs 32 | pip-log.txt 33 | pip-delete-this-directory.txt 34 | 35 | # Unit test / coverage reports 36 | htmlcov/ 37 | .tox/ 38 | .coverage 39 | .cache 40 | nosetests.xml 41 | coverage.xml 42 | 43 | # Translations 44 | *.mo 45 | *.pot 46 | 47 | # Django stuff: 48 | *.log 49 | 50 | # Sphinx documentation 51 | docs/_build/ 52 | 53 | # PyBuilder 54 | target/ 55 | -------------------------------------------------------------------------------- /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 | # YCM-Generator 2 | This is a script which generates a list of compiler flags from a project with an arbitrary build system. It can be used to: 3 | 4 | * generate a ```.ycm_extra_conf.py``` file for use with [YouCompleteMe](https://github.com/Valloric/YouCompleteMe) 5 | * generate a ```.color_coded``` file for use with [color_coded](https://github.com/jeaye/color_coded) 6 | 7 | It works by building the project with a fake toolchain, which simply and filters compiler flags to be stored in the resulting file. 8 | 9 | It is reasonably fast, taking ~10 seconds to generate a configuration file for the Linux kernel. 10 | 11 | ## Status 12 | This plugin is in maintenance mode. I am happy to merge PRs and triage bug reports, but am not actively working on it. 13 | 14 | ## Installation 15 | Add ```NeoBundle 'rdnetto/YCM-Generator'``` to your vimrc (or the equivalent for your plugin manager). 16 | 17 | For [vim-plug](https://github.com/junegunn/vim-plug) users, add ```Plug 'rdnetto/YCM-Generator', { 'branch': 'stable'}``` to your vimrc. 18 | 19 | Alternatively, Arch Linux users can install YCM-Generator using the (unofficial) [AUR package](https://aur4.archlinux.org/packages/ycm-generator-git/). 20 | 21 | ## Usage 22 | Run ```./config_gen.py PROJECT_DIRECTORY```, where ```PROJECT_DIRECTORY``` is the root directory of your project's build system (i.e. the one containing the root Makefile, etc.) 23 | 24 | You can also invoke it from within Vim using the ```:YcmGenerateConfig``` or ```:CCGenerateConfig``` commands to generate a config file for the current directory. These commands accept the same arguments as ```./config_gen.py```, but do not require the project directory to be specified (it defaults to the current working directory). 25 | 26 | ## Requirements and Limitations 27 | * Requirements: 28 | + Python 2 29 | + Clang 30 | 31 | * Supported build systems: 32 | + make 33 | + cmake 34 | + qmake 35 | + autotools 36 | 37 | Your build system should support specifying the compiler through the ```CC```/```CXX``` environment variables, or not use an absolute path to the compiler. 38 | 39 | Some flags present in the resulting configuration file may be mutually exclusive with each other - reading the generated file prior to use is recommended. 40 | 41 | The script assumes that executables with the names `clang` and `clang++` exist in your `PATH`. This has been known to cause issues under Ubuntu, where the C++ compiler may be called `clang++-3.6` (see #50). 42 | 43 | ## Documentation & Support 44 | * run ```./config_gen.py --help``` to see the complete list of supported options. 45 | * if you receive the error message ```ERROR: No commands were logged to the build logs```, try using the ```--verbose``` flag to see any error messages 46 | + some build systems require certain environment variables to be set. Note that these will *not* be used by YCM-Generator by default, unless `--preserve-environment` is used 47 | + if you open an issue regarding this error message, please include the output when running with ```--verbose``` and a link to the project repo (if possible) 48 | 49 | ## Development 50 | Patches are welcome. Please submit pull requests against the ```develop``` branch. 51 | 52 | ### Windows support 53 | The script is currently supported under Unices (Linux, NixOS[1], BSD, OS X) only. 54 | Implementing Windows support consists of porting the contents of ```fake-toolchain/Unix```. 55 | If you are interested in implementing/testing this, please open a pull request. 56 | 57 | [1] May require `--preserve-environment` - see [#19](https://github.com/rdnetto/YCM-Generator/issues/19) 58 | 59 | ### Test Cases 60 | The following projects are used for testing: 61 | 62 | | Project | Build system | Notes | 63 | | ------------------------------------------------------------------------- | ----------------- | ------ | 64 | | [Linux kernel](https://git.kernel.org) | Kbuild (Make) | | 65 | | [Vim-qt](https://bitbucket.org/equalsraf/vim-qt.git) | Autotools | | 66 | | [Clementine](https://github.com/clementine-player/Clementine.git) | Cmake | | 67 | | [ExtPlane](https://github.com/vranki/ExtPlane.git) | Qmake | Should be tested with both versions of Qt. | 68 | | [OpenFOAM](https://github.com/OpenFOAM/OpenFOAM-3.0.x.git) | wmake | | 69 | 70 | ## License 71 | YCM-Generator is published under the GNU GPLv3. 72 | 73 | -------------------------------------------------------------------------------- /config_gen.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | 3 | import sys 4 | import os 5 | import os.path 6 | import re 7 | import argparse 8 | import datetime 9 | import multiprocessing 10 | import shlex 11 | import shutil 12 | import tempfile 13 | import time 14 | import subprocess 15 | import glob 16 | 17 | 18 | # Default flags for make 19 | default_make_flags = ["-i", "-j" + str(multiprocessing.cpu_count())] 20 | 21 | # Set YCM-Generator directory 22 | # Always obtain the real path to the directory where 'config_gen.py' lives as, 23 | # in some cases, it will be a symlink placed in '/usr/bin' (as is the case 24 | # with the Arch Linux AUR package) and it won't 25 | # be able to find the plugin directory. 26 | ycm_generator_dir = os.path.dirname(os.path.realpath(__file__)) 27 | 28 | 29 | def main(): 30 | # parse command-line args 31 | parser = argparse.ArgumentParser(description="Automatically generates config files for YouCompleteMe") 32 | parser.add_argument("-v", "--verbose", action="store_true", help="Show output from build process") 33 | parser.add_argument("-f", "--force", action="store_true", help="Overwrite the file if it exists.") 34 | parser.add_argument("-m", "--make", default="make", help="Use the specified executable for make.") 35 | parser.add_argument("-b", "--build-system", choices=["cmake", "autotools", "qmake", "make"], help="Force use of the specified build system rather than trying to autodetect.") 36 | parser.add_argument("-c", "--compiler", help="Use the specified executable for clang. It should be the same version as the libclang used by YCM. The executable for clang++ will be inferred from this.") 37 | parser.add_argument("-C", "--configure_opts", default="", help="Additional flags to pass to configure/cmake/etc. e.g. --configure_opts=\"--enable-FEATURE\"") 38 | parser.add_argument("-F", "--format", choices=["ycm", "cc"], default="ycm", help="Format of output file (YouCompleteMe or color_coded). Default: ycm") 39 | parser.add_argument("-M", "--make-flags", help="Flags to pass to make when fake-building. Default: -M=\"{}\"".format(" ".join(default_make_flags))) 40 | parser.add_argument("-o", "--output", help="Save the config file as OUTPUT. Default: .ycm_extra_conf.py, or .color_coded if --format=cc.") 41 | parser.add_argument("-x", "--language", choices=["c", "c++"], help="Only output flags for the given language. This defaults to whichever language has its compiler invoked the most.") 42 | parser.add_argument("--out-of-tree", action="store_true", help="Build autotools projects out-of-tree. This is a no-op for other project types.") 43 | parser.add_argument("--qt-version", choices=["4", "5"], default="5", help="Use the given Qt version for qmake. (Default: 5)") 44 | parser.add_argument("-e", "--preserve-environment", action="store_true", help="Pass environment variables to build processes.") 45 | parser.add_argument("PROJECT_DIR", help="The root directory of the project.") 46 | args = vars(parser.parse_args()) 47 | project_dir = os.path.abspath(args["PROJECT_DIR"]) 48 | 49 | # verify that project_dir exists 50 | if(not os.path.exists(project_dir)): 51 | print("ERROR: '{}' does not exist".format(project_dir)) 52 | return 1 53 | 54 | # verify the clang is installed, and infer the correct name for both the C and C++ compilers 55 | try: 56 | cc = args["compiler"] or "clang" 57 | args["cc"] = subprocess.check_output(["which", cc]).strip() 58 | except subprocess.CalledProcessError: 59 | print("ERROR: Could not find clang at '{}'. Please make sure it is installed and is either in your path, or specified with --compiler.".format(cc)) 60 | return 1 61 | 62 | try: 63 | h, t = os.path.split(args["compiler"] or "clang") 64 | cxx = os.path.join(h, t.replace("clang", "clang++")) 65 | args["cxx"] = subprocess.check_output(["which", cxx]).strip() 66 | except subprocess.CalledProcessError: 67 | print("ERROR: Could not find clang++ at '{}'. Please make sure it is installed and specified appropriately.".format(cxx)) 68 | return 1 69 | 70 | # sanity check - remove this after we add Windows support 71 | if(sys.platform.startswith("win32")): 72 | print("ERROR: Windows is not supported") 73 | 74 | # prompt user to overwrite existing file (if necessary) 75 | config_file = { 76 | None: args["output"], 77 | "cc": os.path.join(project_dir, ".color_coded"), 78 | "ycm": os.path.join(project_dir, ".ycm_extra_conf.py"), 79 | }[args["format"] if args["output"] is None else None] 80 | 81 | if(os.path.exists(config_file) and not args["force"]): 82 | print("'{}' already exists. Overwrite? [y/N] ".format(config_file)), 83 | response = sys.stdin.readline().strip().lower() 84 | 85 | if(response != "y" and response != "yes"): 86 | return 1 87 | 88 | # command-line args to pass to fake_build() using kwargs 89 | args["make_cmd"] = args.pop("make") 90 | args["configure_opts"] = shlex.split(args["configure_opts"]) 91 | args["make_flags"] = default_make_flags if args["make_flags"] is None else shlex.split(args["make_flags"]) 92 | force_lang = args.pop("language") 93 | output_format = args.pop("format") 94 | del args["compiler"] 95 | del args["force"] 96 | del args["output"] 97 | del args["PROJECT_DIR"] 98 | 99 | generate_conf = { 100 | "ycm": generate_ycm_conf, 101 | "cc": generate_cc_conf, 102 | }[output_format] 103 | 104 | # temporary files to hold build logs 105 | with tempfile.NamedTemporaryFile(mode="rw") as c_build_log: 106 | with tempfile.NamedTemporaryFile(mode="rw") as cxx_build_log: 107 | # perform the actual compilation of flags 108 | fake_build(project_dir, c_build_log.name, cxx_build_log.name, **args) 109 | (c_count, c_skip, c_flags) = parse_flags(c_build_log) 110 | (cxx_count, cxx_skip, cxx_flags) = parse_flags(cxx_build_log) 111 | 112 | print("Collected {} relevant entries for C compilation ({} discarded).".format(c_count, c_skip)) 113 | print("Collected {} relevant entries for C++ compilation ({} discarded).".format(cxx_count, cxx_skip)) 114 | 115 | # select the language to compile for. If -x was used, zero all other options (so we don't need to repeat the error code) 116 | if(force_lang == "c"): 117 | cxx_count = 0 118 | elif(force_lang == "c++"): 119 | c_count = 0 120 | 121 | if(c_count == 0 and cxx_count == 0): 122 | print("") 123 | print("ERROR: No commands were logged to the build logs (C: {}, C++: {}).".format(c_build_log.name, cxx_build_log.name)) 124 | print("Your build system may not be compatible.") 125 | 126 | if(not args["verbose"]): 127 | print("") 128 | print("Try running with the --verbose flag to see build system output - the most common cause of this is a hardcoded compiler path.") 129 | 130 | c_build_log.delete = False 131 | cxx_build_log.delete = False 132 | return 3 133 | 134 | elif(c_count > cxx_count): 135 | lang, flags = ("c", c_flags) 136 | else: 137 | lang, flags = ("c++", cxx_flags) 138 | 139 | generate_conf(["-x", lang] + flags, config_file) 140 | print("Created {} config file with {} {} flags".format(output_format.upper(), len(flags), lang.upper())) 141 | 142 | 143 | def fake_build(project_dir, c_build_log_path, cxx_build_log_path, verbose, make_cmd, build_system, cc, cxx, out_of_tree, configure_opts, make_flags, preserve_environment, qt_version): 144 | '''Builds the project using the fake toolchain, to collect the compiler flags. 145 | 146 | project_dir: the directory containing the source files 147 | build_log_path: the file to log commands to 148 | verbose: show the build process output 149 | make_cmd: the path of the make executable 150 | cc: the path of the clang executable 151 | cxx: the path of the clang++ executable 152 | out_of_tree: perform an out-of-tree build (autotools only) 153 | configure_opts: additional flags for configure stage 154 | make_flags: additional flags for make 155 | preserve_environment: pass environment variables to build processes 156 | qt_version: The Qt version to use when building with qmake. 157 | ''' 158 | 159 | # TODO: add Windows support 160 | assert(not sys.platform.startswith("win32")) 161 | fake_path = os.path.join(ycm_generator_dir, "fake-toolchain", "Unix") 162 | 163 | # environment variables and arguments for build process 164 | started = time.time() 165 | FNULL = open(os.devnull, "w") 166 | proc_opts = {} if verbose else { 167 | "stdin": FNULL, 168 | "stdout": FNULL, 169 | "stderr": FNULL 170 | } 171 | proc_opts["cwd"] = project_dir 172 | 173 | if(preserve_environment): 174 | env = os.environ 175 | else: 176 | # Preserve HOME, since Cmake needs it to find some packages and it's 177 | # normally there anyway. See #26. 178 | env = dict(map(lambda x: (x, os.environ[x]), ["HOME"])) 179 | 180 | env["PATH"] = "{}:{}".format(fake_path, os.environ["PATH"]) 181 | env["CC"] = "clang" 182 | env["CXX"] = "clang++" 183 | env["YCM_CONFIG_GEN_CC_LOG"] = c_build_log_path 184 | env["YCM_CONFIG_GEN_CXX_LOG"] = cxx_build_log_path 185 | 186 | # used during configuration stage, so that cmake, etc. can verify what the compiler supports 187 | env_config = env.copy() 188 | env_config["YCM_CONFIG_GEN_CC_PASSTHROUGH"] = cc 189 | env_config["YCM_CONFIG_GEN_CXX_PASSTHROUGH"] = cxx 190 | 191 | # use -i (ignore errors), since the makefile may include scripts which 192 | # depend upon the existence of various output files 193 | make_args = [make_cmd] + make_flags 194 | 195 | # Used for the qmake build system below 196 | pro_files = glob.glob(os.path.join(project_dir, "*.pro")) 197 | 198 | # sanity check - make sure the toolchain is available 199 | assert os.path.exists(fake_path), "Could not find toolchain at '{}'".format(fake_path) 200 | 201 | # helper function to display exact commands used 202 | def run(cmd, *args, **kwargs): 203 | print("$ " + " ".join(cmd)) 204 | subprocess.call(cmd, *args, **kwargs) 205 | 206 | if build_system is None: 207 | if os.path.exists(os.path.join(project_dir, "CMakeLists.txt")): 208 | build_system = "cmake" 209 | elif os.path.exists(os.path.join(project_dir, "configure")): 210 | build_system = "autotools" 211 | elif pro_files: 212 | build_system = "qmake" 213 | elif any([os.path.exists(os.path.join(project_dir, x)) for x in ["GNUmakefile", "makefile", "Makefile"]]): 214 | build_system = "make" 215 | 216 | # execute the build system 217 | if build_system == "cmake": 218 | # cmake 219 | # run cmake in a temporary directory, then compile the project as usual 220 | build_dir = tempfile.mkdtemp() 221 | proc_opts["cwd"] = build_dir 222 | 223 | # if the project was built in-tree, we need to hide the cache file so that cmake 224 | # populates the build dir instead of just re-generating the existing files 225 | cache_path = os.path.join(project_dir, "CMakeCache.txt") 226 | 227 | if(os.path.exists(cache_path)): 228 | fd, cache_tmp = tempfile.mkstemp() 229 | os.close(fd) 230 | shutil.move(cache_path, cache_tmp) 231 | else: 232 | cache_tmp = None 233 | 234 | print("Running cmake in '{}'...".format(build_dir)) 235 | sys.stdout.flush() 236 | run(["cmake", project_dir] + configure_opts, env=env_config, **proc_opts) 237 | 238 | print("\nRunning make...") 239 | sys.stdout.flush() 240 | run(make_args, env=env, **proc_opts) 241 | 242 | print("\nCleaning up...") 243 | print("") 244 | sys.stdout.flush() 245 | shutil.rmtree(build_dir) 246 | 247 | if(cache_tmp): 248 | shutil.move(cache_tmp, cache_path) 249 | 250 | elif build_system == "autotools": 251 | # autotools 252 | # perform build in-tree, since not all projects handle out-of-tree builds correctly 253 | 254 | if(out_of_tree): 255 | build_dir = tempfile.mkdtemp() 256 | proc_opts["cwd"] = build_dir 257 | print("Configuring autotools in '{}'...".format(build_dir)) 258 | else: 259 | print("Configuring autotools...") 260 | 261 | run([os.path.join(project_dir, "configure")] + configure_opts, env=env_config, **proc_opts) 262 | 263 | print("\nRunning make...") 264 | run(make_args, env=env, **proc_opts) 265 | 266 | print("\nCleaning up...") 267 | 268 | if(out_of_tree): 269 | print("") 270 | shutil.rmtree(build_dir) 271 | else: 272 | run([make_cmd, "maintainer-clean"], env=env, **proc_opts) 273 | 274 | elif build_system == "qmake": 275 | # qmake 276 | # make sure there is only one .pro file 277 | if len(pro_files) != 1: 278 | print("ERROR: Found {} .pro files (expected one): {}.".format( 279 | len(pro_files), ', '.join(pro_files))) 280 | sys.exit(1) 281 | 282 | # run qmake in a temporary directory, then compile the project as usual 283 | build_dir = tempfile.mkdtemp() 284 | proc_opts["cwd"] = build_dir 285 | env_config["QT_SELECT"] = qt_version 286 | 287 | # QMAKESPEC is platform dependent - valid mkspecs are in 288 | # /usr/share/qt4/mkspecs, /usr/lib64/qt5/mkspecs 289 | env_config["QMAKESPEC"] = { 290 | ("Linux", True): "unsupported/linux-clang", 291 | ("Linux", False): "linux-clang", 292 | ("Darwin", True): "unsupported/macx-clang", 293 | ("Darwin", False): "macx-clang", 294 | ("FreeBSD", False): "unsupported/freebsd-clang", 295 | }[(os.uname()[0], qt_version == "4")] 296 | 297 | print("Running qmake in '{}' with Qt {}...".format(build_dir, qt_version)) 298 | run(["qmake"] + configure_opts + [pro_files[0]], env=env_config, 299 | **proc_opts) 300 | 301 | print("\nRunning make...") 302 | run(make_args, env=env, **proc_opts) 303 | 304 | print("\nCleaning up...") 305 | print("") 306 | shutil.rmtree(build_dir) 307 | 308 | elif build_system == "make": 309 | # make 310 | # needs to be handled last, since other build systems can generate Makefiles 311 | print("Preparing build directory...") 312 | run([make_cmd, "clean"], env=env, **proc_opts) 313 | 314 | print("\nRunning make...") 315 | run(make_args, env=env, **proc_opts) 316 | 317 | elif(os.path.exists(os.path.join(project_dir, "Make/options"))): 318 | print("Found OpenFOAM Make/options") 319 | 320 | # OpenFOAM build system 321 | make_args = ["wmake"] 322 | 323 | # Since icpc could not find directory in which g++ resides, 324 | # set environmental variables to gcc to make fake_build operate normally. 325 | 326 | env['WM_COMPILER']='Gcc' 327 | env['WM_CC']='gcc' 328 | env['WM_CXX']='g++' 329 | 330 | print("\nRunning wmake...") 331 | run(make_args, env=env, **proc_opts) 332 | 333 | else: 334 | print("ERROR: Unknown build system") 335 | sys.exit(2) 336 | 337 | print("Build completed in {} sec".format(round(time.time() - started, 2))) 338 | print("") 339 | 340 | 341 | def parse_flags(build_log): 342 | '''Creates a list of compiler flags from the build log. 343 | 344 | build_log: an iterator of lines 345 | Returns: (line_count, skip_count, flags) 346 | flags is a list, and the counts are integers 347 | ''' 348 | 349 | # Used to ignore entries which result in temporary files, or don't fully 350 | # compile the file 351 | temp_output = re.compile("(-x assembler)|(-o ([a-zA-Z0-9._].tmp))|(/dev/null)") 352 | skip_count = 0 353 | 354 | # Flags we want: 355 | # -includes (-i, -I) 356 | # -defines (-D) 357 | # -warnings (-Werror), but no assembler, etc. flags (-Wa,-option) 358 | # -language (-std=gnu99) and standard library (-nostdlib) 359 | # -word size (-m64) 360 | flags_whitelist = ["-[iIDF].*", "-W[^,]*", "-std=[a-z0-9+]+", "-(no)?std(lib|inc)", "-m[0-9]+"] 361 | flags_whitelist = re.compile("|".join(map("^{}$".format, flags_whitelist))) 362 | flags = set() 363 | line_count = 0 364 | 365 | # macro definitions should be handled separately, so we can resolve duplicates 366 | define_flags = dict() 367 | define_regex = re.compile("-D([a-zA-Z0-9_]+)=(.*)") 368 | 369 | # Used to only bundle filenames with applicable arguments 370 | filename_flags = ["-o", "-I", "-isystem", "-iquote", "-include", "-imacros", "-isysroot"] 371 | 372 | # Process build log 373 | for line in build_log: 374 | if(temp_output.search(line)): 375 | skip_count += 1 376 | continue 377 | 378 | line_count += 1 379 | words = split_flags(line) 380 | 381 | for (i, word) in enumerate(words): 382 | if(word[0] != '-' or not flags_whitelist.match(word)): 383 | continue 384 | 385 | # handle macro definitions 386 | m = define_regex.match(word) 387 | if(m): 388 | if(m.group(1) not in define_flags): 389 | define_flags[m.group(1)] = [m.group(2)] 390 | elif(m.group(2) not in define_flags[m.group(1)]): 391 | define_flags[m.group(1)].append(m.group(2)) 392 | 393 | continue 394 | 395 | # include arguments for this option, if there are any, as a tuple 396 | if(i != len(words) - 1 and word in filename_flags and words[i + 1][0] != '-'): 397 | flags.add((word, words[i + 1])) 398 | else: 399 | flags.add(word) 400 | 401 | # Only specify one word size (the largest) 402 | # (Different sizes are used for different files in the linux kernel.) 403 | mRegex = re.compile("^-m[0-9]+$") 404 | word_flags = list([f for f in flags if isinstance(f, basestring) and mRegex.match(f)]) 405 | 406 | if(len(word_flags) > 1): 407 | for flag in word_flags: 408 | flags.remove(flag) 409 | 410 | flags.add(max(word_flags)) 411 | 412 | # Resolve duplicate macro definitions (always choose the last value for consistency) 413 | for name, values in define_flags.iteritems(): 414 | if(len(values) > 1): 415 | print("WARNING: {} distinct definitions of macro {} found".format(len(values), name)) 416 | values.sort() 417 | 418 | flags.add("-D{}={}".format(name, values[0])) 419 | 420 | return (line_count, skip_count, sorted(flags)) 421 | 422 | 423 | def generate_cc_conf(flags, config_file): 424 | '''Generates the .color_coded file 425 | 426 | flags: the list of flags 427 | config_file: the path to save the configuration file at''' 428 | 429 | with open(config_file, "w") as output: 430 | for flag in flags: 431 | if(isinstance(flag, basestring)): 432 | output.write(flag + "\n") 433 | else: # is tuple 434 | for f in flag: 435 | output.write(f + "\n") 436 | 437 | 438 | def generate_ycm_conf(flags, config_file): 439 | '''Generates the .ycm_extra_conf.py. 440 | 441 | flags: the list of flags 442 | config_file: the path to save the configuration file at''' 443 | 444 | template_file = os.path.join(ycm_generator_dir, "template.py") 445 | 446 | with open(template_file, "r") as template: 447 | with open(config_file, "w") as output: 448 | output.write("# Generated by YCM Generator at {}\n\n".format(str(datetime.datetime.today()))) 449 | 450 | for line in template: 451 | if(line == " # INSERT FLAGS HERE\n"): 452 | # insert generated code 453 | for flag in flags: 454 | if(isinstance(flag, basestring)): 455 | output.write(" '{}',\n".format(flag)) 456 | else: # is tuple 457 | output.write(" '{}', '{}',\n".format(*flag)) 458 | 459 | else: 460 | # copy template 461 | output.write(line) 462 | 463 | 464 | def split_flags(line): 465 | '''Helper method that splits a string into flags. 466 | Flags are space-seperated, except for spaces enclosed in quotes. 467 | Returns a list of flags''' 468 | 469 | # Pass 1: split line using whitespace 470 | words = line.strip().split() 471 | 472 | # Pass 2: merge words so that the no. of quotes is balanced 473 | res = [] 474 | 475 | for w in words: 476 | if(len(res) > 0 and unbalanced_quotes(res[-1])): 477 | res[-1] += " " + w 478 | else: 479 | res.append(w) 480 | 481 | return res 482 | 483 | 484 | def unbalanced_quotes(s): 485 | '''Helper method that returns True if the no. of single or double quotes in s is odd.''' 486 | 487 | single = 0 488 | double = 0 489 | 490 | for c in s: 491 | if(c == "'"): 492 | single += 1 493 | elif(c == '"'): 494 | double += 1 495 | 496 | return (single % 2 == 1 or double % 2 == 1) 497 | 498 | 499 | if(__name__ == "__main__"): 500 | # Note that sys.exit() lets us use None and 0 interchangably 501 | sys.exit(main()) 502 | 503 | -------------------------------------------------------------------------------- /fake-toolchain/Unix/ar: -------------------------------------------------------------------------------- 1 | true -------------------------------------------------------------------------------- /fake-toolchain/Unix/as: -------------------------------------------------------------------------------- 1 | true -------------------------------------------------------------------------------- /fake-toolchain/Unix/cc: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | if [ ! -z "$YCM_CONFIG_GEN_CC_PASSTHROUGH" ]; then 4 | # Cmake determines compiler properties by compiling a test file, so call clang for this case 5 | $YCM_CONFIG_GEN_CC_PASSTHROUGH $@ 6 | 7 | elif [ "$1" = "-v" ] || [ "$1" = "--version" ]; then 8 | # Needed to enable clang-specific options for certain build systems (e.g. linux) 9 | $YCM_CONFIG_GEN_CC_PASSTHROUGH $@ 10 | 11 | else 12 | echo "$@" >> $YCM_CONFIG_GEN_CC_LOG 13 | fi 14 | 15 | -------------------------------------------------------------------------------- /fake-toolchain/Unix/clang: -------------------------------------------------------------------------------- 1 | cc -------------------------------------------------------------------------------- /fake-toolchain/Unix/clang++: -------------------------------------------------------------------------------- 1 | cxx -------------------------------------------------------------------------------- /fake-toolchain/Unix/cxx: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | if [ ! -z "$YCM_CONFIG_GEN_CC_PASSTHROUGH" ]; then 4 | # Cmake determines compiler properties by compiling a test file, so call clang for this case 5 | $YCM_CONFIG_GEN_CXX_PASSTHROUGH $@ 6 | 7 | elif [ "$1" = "-v" ] || [ "$1" = "--version" ]; then 8 | # Needed to enable clang-specific options for certain build systems (e.g. linux) 9 | $YCM_CONFIG_GEN_CXX_PASSTHROUGH $@ 10 | 11 | else 12 | echo "$@" >> $YCM_CONFIG_GEN_CXX_LOG 13 | fi 14 | 15 | -------------------------------------------------------------------------------- /fake-toolchain/Unix/g++: -------------------------------------------------------------------------------- 1 | cxx -------------------------------------------------------------------------------- /fake-toolchain/Unix/gcc: -------------------------------------------------------------------------------- 1 | cc -------------------------------------------------------------------------------- /fake-toolchain/Unix/gcc++: -------------------------------------------------------------------------------- 1 | cxx -------------------------------------------------------------------------------- /fake-toolchain/Unix/ld: -------------------------------------------------------------------------------- 1 | true -------------------------------------------------------------------------------- /fake-toolchain/Unix/nm: -------------------------------------------------------------------------------- 1 | true -------------------------------------------------------------------------------- /fake-toolchain/Unix/true: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # This script is needed because /bin/true does not exist on non-FHS-compliant distros. e.g. NixOS 3 | exit 0 4 | 5 | -------------------------------------------------------------------------------- /plugin/ycm-generator.vim: -------------------------------------------------------------------------------- 1 | 2 | let s:config_gen = expand(":p:h:h") . "/config_gen.py" 3 | 4 | command! -nargs=? -complete=file_in_path -bang CCGenerateConfig call s:GenerateConfig("cc", 0, "") 5 | command! -nargs=? -complete=file_in_path -bang YcmGenerateConfig call s:GenerateConfig("ycm", 0, "") 6 | 7 | function! s:GenerateConfig(fmt, overwrite, flags) 8 | let l:cmd = "! " . s:config_gen . " -F " . a:fmt . " " . a:flags 9 | 10 | if a:overwrite 11 | let l:cmd = l:cmd . " -f" 12 | endif 13 | 14 | " Only append the working directory if the last option is a flag 15 | let l:split_flags = split(a:flags) 16 | if len(l:split_flags) == 0 || l:split_flags[-1] =~ "^-" 17 | let l:cmd = l:cmd . " " . shellescape(getcwd()) 18 | endif 19 | 20 | " Disable interactive prompts for consistency with Neovim 21 | execute l:cmd . " 30 | 31 | import os 32 | import ycm_core 33 | 34 | flags = [ 35 | # INSERT FLAGS HERE 36 | ] 37 | 38 | 39 | # Set this to the absolute path to the folder (NOT the file!) containing the 40 | # compile_commands.json file to use that instead of 'flags'. See here for 41 | # more details: http://clang.llvm.org/docs/JSONCompilationDatabase.html 42 | # 43 | # You can get CMake to generate this file for you by adding: 44 | # set( CMAKE_EXPORT_COMPILE_COMMANDS 1 ) 45 | # to your CMakeLists.txt file. 46 | # 47 | # Most projects will NOT need to set this to anything; you can just change the 48 | # 'flags' list of compilation flags. Notice that YCM itself uses that approach. 49 | compilation_database_folder = '' 50 | 51 | if os.path.exists( compilation_database_folder ): 52 | database = ycm_core.CompilationDatabase( compilation_database_folder ) 53 | else: 54 | database = None 55 | 56 | SOURCE_EXTENSIONS = [ '.C', '.cpp', '.cxx', '.cc', '.c', '.m', '.mm' ] 57 | 58 | def DirectoryOfThisScript(): 59 | return os.path.dirname( os.path.abspath( __file__ ) ) 60 | 61 | 62 | def MakeRelativePathsInFlagsAbsolute( flags, working_directory ): 63 | if not working_directory: 64 | return list( flags ) 65 | new_flags = [] 66 | make_next_absolute = False 67 | path_flags = [ '-isystem', '-I', '-iquote', '--sysroot=' ] 68 | for flag in flags: 69 | new_flag = flag 70 | 71 | if make_next_absolute: 72 | make_next_absolute = False 73 | if not flag.startswith( '/' ): 74 | new_flag = os.path.join( working_directory, flag ) 75 | 76 | for path_flag in path_flags: 77 | if flag == path_flag: 78 | make_next_absolute = True 79 | break 80 | 81 | if flag.startswith( path_flag ): 82 | path = flag[ len( path_flag ): ] 83 | new_flag = path_flag + os.path.join( working_directory, path ) 84 | break 85 | 86 | if new_flag: 87 | new_flags.append( new_flag ) 88 | return new_flags 89 | 90 | 91 | def IsHeaderFile( filename ): 92 | extension = os.path.splitext( filename )[ 1 ] 93 | return extension in [ '.H', '.h', '.hxx', '.hpp', '.hh' ] 94 | 95 | 96 | def GetCompilationInfoForFile( filename ): 97 | # The compilation_commands.json file generated by CMake does not have entries 98 | # for header files. So we do our best by asking the db for flags for a 99 | # corresponding source file, if any. If one exists, the flags for that file 100 | # should be good enough. 101 | if IsHeaderFile( filename ): 102 | basename = os.path.splitext( filename )[ 0 ] 103 | for extension in SOURCE_EXTENSIONS: 104 | replacement_file = basename + extension 105 | if os.path.exists( replacement_file ): 106 | compilation_info = database.GetCompilationInfoForFile( 107 | replacement_file ) 108 | if compilation_info.compiler_flags_: 109 | return compilation_info 110 | return None 111 | return database.GetCompilationInfoForFile( filename ) 112 | 113 | 114 | def FlagsForFile( filename, **kwargs ): 115 | if database: 116 | # Bear in mind that compilation_info.compiler_flags_ does NOT return a 117 | # python list, but a "list-like" StringVec object 118 | compilation_info = GetCompilationInfoForFile( filename ) 119 | if not compilation_info: 120 | return None 121 | 122 | final_flags = MakeRelativePathsInFlagsAbsolute( 123 | compilation_info.compiler_flags_, 124 | compilation_info.compiler_working_dir_ ) 125 | 126 | else: 127 | relative_to = DirectoryOfThisScript() 128 | final_flags = MakeRelativePathsInFlagsAbsolute( flags, relative_to ) 129 | 130 | return { 131 | 'flags': final_flags, 132 | 'do_cache': True 133 | } 134 | 135 | def Settings( **kwargs ): 136 | language = kwargs[ 'language' ] 137 | if language == 'cfamily': 138 | return { 139 | 'flags': flags 140 | } 141 | 142 | return {} 143 | --------------------------------------------------------------------------------