├── LICENSE └── README.md /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 | 635 | Copyright (C) 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 | Copyright (C) 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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Маленькая книга о Lua 2 | ![image](https://user-images.githubusercontent.com/3950155/189185483-e1a5fe4d-dc95-4cca-94d5-3976abc46ec3.png) 3 | 4 | Карлу Сегуину - с благодарностью за "маленькую библиотеку". 5 | 6 | ## Введение 7 | 8 | Есть прекрасная книга "Программирование на Lua", написанная автором языка. Это настоящий учебник, освещающий все тонкости и особенности языка. Там даже упражнения есть. Будете ли вы её читать просто для ознакомления с еще одним языком программирования? Я думаю, что нет. 9 | 10 | Другая крайность - это "Lua за 60 минут". Я видел подобные статьи и не могу однозначно сказать, приносят ли они пользу или причиняют вред. Для меня знакомство с Lua началось именно с этой статьи, но я понял из нее только то, что нуждаюсь в более глубоких источниках, чем прокомментированные сниппеты. 11 | 12 | "Маленькие книги" Карла Сегуина настолько точно отвечают на мой запрос, что я набрался смелости присоединиться к жанру. Если моя "маленькая книга" будет хотя бы наполовину настолько хороша, то я сочту задачу выполненной. 13 | 14 | Читайте подряд. Последовательность изложения отличается от канонической, зато вам ни разу не встретится раздражающее "вы поймете это потом". Это быстрое чтиво, простое и легкое (надеюсь!), которое поможет понять, стоит ли переходить к более глубокому изучению или уже пора остановиться и больше не тратить время. 15 | 16 | ## Применимость 17 | 18 | Применимость - это ответ на вопрос "зачем". Существует совершенно безумное количество языков программирования и у каждого есть свой ответ на этот вопрос. Lua появился в недрах университетской кафедры компьютерной графики как встраиваемый язык для приложений на С. 19 | 20 | Описывая Lua, автор называет его расширяемым (то есть умеющим вызывать функции приложения) и расширяющим (то есть умеющим предоставлять свои функции приложению). Будучи сам написан на C, он легко встраивается в C-приложения и взаимодействует с ним. Это совсем не означает, что единственная аудитория языка это программисты на C, но... да, им он полезней всего. 21 | 22 | При этом Lua предлагает и самостоятельный интерпретатор, который может использовать внешние динамические библиотеки - как написанные специально для Lua, так и любые другие - с помощью механизма FFI. Во втором случае, правда, дополнительно потребуется библиотека expat или интерпретатор LuaJIT (написанный другим автором, но полностью совместимый с оригинальным Lua), в котором не только реализован FFI, но есть еще и JIT-компиляция, многократно ускоряющий и без того быстрый Lua. 23 | 24 | Кстати, о быстродействии. Lua быстр - настолько, что из интерпретаторов с ним могут сравниться лишь Python и JavaScript, а LuaJIT в некоторых задачах их даже опережает (но это спорный момент, поэтому лучше остановимся на "сравним по быстродействию"). 25 | 26 | Lua компактен - настолько, что его используют в маршрутизаторах Miktotik, телефонных станциях Asterisk и даже "зашивают" в микросхемы. 27 | 28 | И он прост. Его включают в сетевые сканеры nmap и wireshark, он работает внутри баз данных Redis и Tarantool, на нем пишут плагины для медиаплеера Rhythmbox... даже биржевых ботов на платформе Quik. Это немного похоже на "бойцовский клуб" - многие используют Lua, ничего о нем не зная, просто как часть платформы. 29 | 30 | Кроме того, на Lua неплохо получаются веб-приложения - благодаря реализованной в проекте OpenResty интеграции c Nginx получаются весьма выносливые к нагрузкам системы. Такие как AliExpress, например. Или CloudFlare. 31 | 32 | С легкостью создаются настольные приложения с графическим интерфейсом - с помощью IUP, QT, wxWidgets, FLTK или чего-нибудь еще. Не только под Linux, но и под Windows, MacOS или вообще без графической среды, в "сыром" framebuffer. 33 | 34 | Графика, "то, ради чего" Lua писался изначально, открывает дорогу в игровую индустрию. Love2D, специально написанный игровой движок, работает не только в настольных операционных системах, но и на мобильных устройствах. Unity, трехмерный игровой движок, лежит в основе довольно серьезных игровых проектов. Для игр класса AAA, правда, потребуется написать платформу на более "машинном" языке, но внутри MTA, World of Warcraft и S.T.A.L.K.E.R. используется все тот же Lua. 35 | 36 | А вот задачи реального времени на Lua делать нельзя, даже если использовать микросхемы NodeMCU. Это интерпретатор для виртуальной машины и доступа к реальному оборудованию у него нет. Не поможет даже написать "подложку" с прямым доступом и управлять ею (в играх так и делается), это будет лишь приближением к желаемому - виртуальная машина асинхронно выполняет свои задачи и вы никогда не сможете выполнить что-то "прямо сейчас". Как бы ни была мала эта задержка, "взрослые" задачи реального времени не для Lua. Оставим это Erlang-у. 37 | 38 | ## Установка 39 | 40 | Можно собрать Lua из исходников с сайта [lua.org](https://lua.org/). Это самый суровый путь, но если вы линуксоид, то вам не привыкать. При помощи MinGW, CygWin или Windows Platform SDK вы точно так же можете собрать его и для Windows. Но это необязательно - во многих дистрибутивах Linux бинарные сборки доступны из менеджера пакетов. Для Windows их тоже можно найти и скачать из Интернета. Ну, или установить при помощи Chocolatey - тамошнего аналога пакетного менеджера. 41 | 42 | ## Запуск программ 43 | 44 | Если просто запустить интерпретатор - он запустится в интерактивном режиме, где весьма неплох в качестве калькулятора. 45 | 46 | ``` 47 | $ lua 48 | Lua 5.3.5 Copyright (C) 1994-2018 Lua.org, PUC-Rio 49 | > 2 + 2 * 2 50 | 6 51 | ``` 52 | 53 | В интерактивном режиме можно поэкспериментировать со всеми возможностями языка, но для реального применения лучше все-таки написать программу и передавать имя с файлом программы интерпретатору для выполнения. 54 | 55 | ```lua 56 | $ lua hello.lua 57 | Hello, World! 58 | ``` 59 | 60 | Содержимое файла **hello.lua** - каноничная первая программа. Те, кто считает, что первая программа должна быть более осмысленной, упускают самое главное её предназначение - проверить работоспособность установленной среды. 61 | 62 | ```lua 63 | print ("Hello, world!") -- print это функция вывода из стандартной библиотеки 64 | ``` 65 | 66 | Вы можете использовать Lua в командных файлах Linux, как и любой другой скриптовый язык. 67 | 68 | ```lua 69 | #!/usr/bin/env lua 70 | print "Hello, world!" -- для вывода одной строки можно обойтись без скобок 71 | ``` 72 | 73 | Сохраните эту программу в файл **hello.lua**, выполните команду **chmod +x hello.lua**, и вы сможете запускать её прямо из консоли: 74 | 75 | ```bash 76 | $ ./hello.lua 77 | Hello, world! 78 | ``` 79 | 80 | ## Комментарии 81 | 82 | Самая бесполезная часть программы - текст комментариев для интерпретатора не существует. Но это еще и самый лучший способ объяснить, что происходит, прямо в коде. 83 | 84 | ```lua 85 | -- это короткий комментарий 86 | --[[ длинные комментарии нужны не только для долгих "лирических отступлений", 87 | но и позволяют временно "отключить" часть кода, не удаляя его ]] 88 | ``` 89 | 90 | ## Переменные 91 | 92 | Переменные не нужно специально объявлять или каким-то образом инициализировать: при первой записи они создается, при повторных - перезаписывается, по завершении программы - удаляется. 93 | 94 | Также нет необходимости определять тип данных, которые будут хранится в переменной - при каждой записи определяется тип сохраняемого значения и выделяется требуемое количество памяти. 95 | 96 | Имена переменных могут содержать латинские буквы, цифры (но не могут с них начинаться) и знак подчеркивания. Нет никаких специальных правил - `СamelCase`, `isHungarianNotation`, `underscore_delimited_names` или любой другой способ могут быть использованы без ограничений и в любом сочетании. 97 | 98 | Имена переменных (как и остальные языковые конструкции) регистрозависимы - `and` является зарезервированным словом и не может использоваться в качестве переменной, а `And` и `AND` - могут. 99 | 100 | Единственное пожелание автора - не использовать переменные, которые начинаются со знака подчеркивания, за которым следуют заглавные буквы. Внутренние переменные могут совпасть с вашими и программа может повести себя, скажем так, странно. 101 | 102 | ## Выражения 103 | 104 | Для записи данных используется операция присваивания. Математически это не равенство, а линейное отображение справа налево. Слева от знака операции должно быть имя переменной, справа - выражение. 105 | 106 | ~~~lua 107 | 4 = a -- это не работает; слева от знака операции только имена переменных 108 | ~~~ 109 | 110 | Выражение это способ представления данных при помощи цифр, операций и имен переменных. А значение выражения - это результат его вычисления. Всякий раз, когда интерпретатору встречается выражение, он его вычисляет, а всякий раз, когда встречается присваивание - сохраняет значение в память и связывает с именем переменной. 111 | 112 | ```lua 113 | a = 4 -- теперь у нас есть переменная "a" и в ней содержится число 2 114 | a, b = 4, 8 -- так тоже можно; это называется множественным присваиванием 115 | a = 2 + 2 * 2-- значение можно записать как результат математической операции 116 | a = b / 2 -- чтение переменных происходит при использовании их в выражениях 117 | a, b = b, a -- простой и элегантный способ поменять значения переменных местами 118 | i = i + 1 -- просто увеличение значения переменной на 1 119 | x = a = b -- теперь и X, и A равны 4 120 | ``` 121 | 122 | Когда в переменной пропадает нужда - она уничтожается сборщиком мусора. В общем, все как везде, где произносятся слова "автоматическая сборка мусора" 123 | 124 | ## Пустое значение 125 | 126 | Оно всего одно и записывается латинским словом `nil`, что переводится как "ничего". Это не нуль, не пустая строка и не нулевой указатель. Это ничего. Его не существует. 127 | 128 | При чтении несуществующей переменной вы получите `nil`. При записи в переменную значения nil вы эту переменную уничтожите. А если вы попробуете присвоить `nil` несуществующей переменной, ничего не произойдет. Вообще. 129 | 130 | ## Логические значения 131 | 132 | Их два - **true** ("истина") и **false** ("ложь"). 133 | 134 | ```lua 135 | a, b = true, false -- их можно напрямую присваивать 136 | 137 | -- они могут быть результатом логических операций 138 | x = not b -- true; логическое НЕ 139 | x = a and b -- false; логическое И 140 | x = a or b -- true; логическое ИЛИ 141 | 142 | --[[ можно выполнять эти операции и с другими типами данных, 143 | логика в этом случае несколько своеобразная, но она есть ]] 144 | 145 | x = not nil -- true; nil аналогичен false 146 | x = not 0 -- false; все остальные значения ведут себя как true, даже 0 147 | x = 4 and 5 -- 5; and возвращает первый аргумент, если он ложный, иначе второй 148 | x = 4 or 5 -- 4; or возвращает первый аргумент, если он НЕ ложный, иначе второй 149 | x = 3 and 4 or 5 -- 4; это аналог тернарной операции "a?b:c" в Си 150 | ``` 151 | 152 | ## Числа 153 | 154 | Для хранения чисел Lua использует 64-битные блоки памяти. Это аналогично типу double в С. В версии 5.3 появились целые числа, но это мало что меняет. Единственная разница - вы можете явно создать число с плавающей точкой, если используете десятичную точку, после которой может быть и нуль. 155 | 156 | ```lua 157 | n = 42 -- ответ на Главный вопрос жизни, вселенной и всего такого 158 | n = 42.0 -- это значение типа double, а не int 159 | n = 0x2A -- он же в шестнадцатиричной системе счисления 160 | n = 420e-1 -- в экспоненциальной форме 161 | n = 0x2A0p-1 -- или даже в экспоненциальной форме шестнадцатиричного счисления 162 | x = 3.1415926 -- у вещественных чисел дробная часть отделяется точкой 163 | y = .5 -- нуль перед десятичным разделителем необязателен 164 | z = -500 -- как и в случае с отрицательными значениями; фактически это "z = 0 - 500" 165 | ``` 166 | 167 | Для чисел доступны основные арифметические операции: 168 | 169 | ```lua 170 | a = 2 + 2 -- 4; сложение 171 | a = 2 - 2 -- 0; вычитание 172 | a = 2 * 2 -- 4; умножение 173 | a = 2 ^ 2 -- 4; возведение в степень 174 | a = 5 / 2 -- 2.5; деление 175 | a = 5 //2 -- 2; целочисленной деление (без дробной части) 176 | a = 5 % 2 -- 1; остаток от целочисленного деления 177 | a = 2 + 2 * 2 -- 6; приоритеты операций, как в школе 178 | a =(2 + 2)* 2 -- 8; но его так же можно менять скобками 179 | ``` 180 | 181 | А также операции сравнения: 182 | 183 | ```lua 184 | a, b = 3, 4 185 | 186 | x = a > b -- false; больше 187 | x = a < b -- true; меньше 188 | x = a >= b -- false; больше или равно 189 | x = a <= b -- true; меньше или равно 190 | x = a == b -- false; равно 191 | x = a ~= b -- true; не равно 192 | ``` 193 | 194 | ## Строки 195 | 196 | Строка - это массив байт. Строка может содержать нулевые символы и это не станет признаком конца строки, символы могут быть в любой кодировке или вообще непечатными. В строках можно хранить любые двоичные данные. Между строками в 1 байт и строками в 10 мегабайт нет разницы. И нет ограничений, кроме размера оперативной памяти. 197 | 198 | Строки нельзя менять, но можно перезаписывать. То есть нельзя влезть в строку и поменять в ней пятый байт, но можно сформировать такую же строку, но с другим пятым байтом и записать в ту же переменную. Как вы понимаете, это означает копирование строки со всеми накладными расходами этой операции. 199 | 200 | ```lua 201 | s = "Для записи строк используются кавычки" 202 | s = 'одиночные кавычки тоже допустимы' 203 | s = "можно комбинировать 'одиночные' и \"двойные\" кавычки в любом сочетании" 204 | s = [[А если в тексте много строк, 205 | никто не мешает хранить его в строке целиком. 206 | Да, при помощи двойных квадратных скобок, как в многострочным комментарии.]] 207 | 208 | с = #'Hello' -- 5; операция # позволяет узнать длину строки (количество байт, не букв!) 209 | s = "строки"..'можно'..[[объединять]] -- это называется "конкатенация" 210 | 211 | w = [[ 212 | Экранирование специальных символов делается как в Си: 213 | \a - звонок (beep) 214 | \b - возврат на одну позицию (backspace) 215 | \r - перевод страницы 216 | \n - перевод строки (newline) 217 | \r - возврат каретки (carriage return) 218 | \t - горизонтальная табуляция 219 | \v - вертикальная табуляция 220 | \\ - обратная косая черта (backslash) 221 | \" - одиночная кавычка 222 | \' - двойная кавычка 223 | ]] 224 | 225 | -- строки можно сравнивать 226 | x = s == w -- false, строки НЕ равны 227 | y = s ~= w -- true, строка НЕ равны 228 | ``` 229 | 230 | ## Привидение типов 231 | 232 | Если к числу применяются строковые операции, оно превращается в строку. И наоборот, если это возможно. 233 | 234 | ~~~lua 235 | a = 100..500 -- 100500 236 | a = "10" + 7 -- 17 237 | a = 12 + "a" -- ошибка 238 | ~~~ 239 | 240 | Это спорная идея. Лучше использовать явные преобразования и не рисковать. 241 | 242 | ~~~lua 243 | a = tostring( 10 ) -- "10"; строка 244 | b = tonumber("10") -- 10 ; число 245 | c = tonumber("XY") -- nil 246 | ~~~ 247 | 248 | ## Таблицы 249 | 250 | Используйте таблицы, если вам нужны массивы, словари, структуры, объекты. Таблицы - это всё. Хотя, на самом деле, таблицы это просто способ хранить множество пар "ключ-значение", а все остальное - это то, какие вы выбираете ключи и какие значения. 251 | 252 | Если в качестве ключей использовать натуральные числа, то это будет массив. 253 | 254 | ```lua 255 | a = {42,616,999} 256 | a[#a + 1] = "Земля-616" -- функция # возвращает количество элементов 257 | print (a[4]) --> Земля-616 258 | ``` 259 | 260 | А еще "натуральные" означает, что нумерация индексов начинается с единицы, а не с нуля. Программистам на C нужно всегда об этом помнить. 261 | 262 | Массивы не надо объявлять и под них не выделяется пространство. И индексы у них необязательно последовательные. Можно использовать большие числа и не бояться, что закончится память - в таблице будет только те ключи, которые вы внесли. Если ключи в таблице не являются натуральной последовательностью, то это разряженный массив. 263 | 264 | ```lua 265 | a = {} 266 | a[13] = 666 267 | a[100500] = "Alpha Centauri" 268 | a[42] = "The Ultimate Question of Life, the Universe, and Everything answer" 269 | print(#a) --> 0, для разряженных массивов операция # неприменима 270 | ``` 271 | 272 | Значения элементов таблицы сами могут быть таблицами. Ограничений на вложенность никаких, таблицы могут быть многомерными матрицами. 273 | 274 | ```lua 275 | a = { 276 | {101,102,103}, 277 | {201,202,203}, 278 | {301,302,303}, -- эта запятая лишняя, но это допустимо 279 | } 280 | print (a[2][3]) --> 203 281 | ``` 282 | 283 | Индексы могут быть строковыми. С их помощью можно реализовать ассоциативные массивы (их еще называют словарями). 284 | 285 | ```lua 286 | a = { 287 | ["one"] = 1,["two"] = 2,["three"] = 3, four = 4, five = "пять" 288 | } 289 | print (a.one) --> 1 290 | print (a["four"]) --> 4 291 | ``` 292 | 293 | Можно заметить, что элементы таблицы определены по-разному и по-разному же вызываются. Вы можете обращаться с таблицей как со словарем, так и как со структурой - это будет все та же таблица. 294 | 295 | ## Фрагменты 296 | 297 | У английского "chunk" есть масса смыслов. Если вы во имя точности предпочитаете англицизмы, используйте "чанк" - вполне сложившийся термин (в описании, например, HTTP-протокола). Если нет, то "фрагмент" ничем не хуже. Суть в том, что это просто какое-то количество инструкций языка без начала, конца и какого-то обрамления. 298 | 299 | ~~~lua 300 | a = 1 301 | print (a) --> 1 302 | a = a + 1 303 | b = a / 2 304 | print (b) --> 1 305 | ~~~ 306 | 307 | В программе на Lua не нужно как-то специально оформлять "точку входа", как это делается в C функцией `main()`. Что касается точки выхода, то её тоже нет - выполнив все инструкции фрагмента, интерпретатор останавливается. 308 | 309 | Вы, конечно, можете написать что-то вроде этого: 310 | 311 | ~~~lua 312 | function main () 313 | a = 1 314 | print (a) --> 1 315 | a = a + 1 316 | b = a / 2 317 | print (b) --> 1 318 | end 319 | main () 320 | ~~~ 321 | 322 | ...но особого смысла в этом нет. Да, сначала объявится функция, но её потом все равно надо будет явным образом вызвать после объявления. И интерпретатору совершенно без разницы, какое у нее имя и надо ли её вообще выполнять. 323 | 324 | Полученный код выполняется "как есть", все остальное - на ваше усмотрение. 325 | 326 | ## Блоки и области видимости 327 | 328 | Несколько инструкций (тот самый "фрагмент") можно разместить между словами `do` и `end`. Это то же самое, что фигурные скобки в C/C++ или `begin .. end` в Pascal. Блок, группирующий инструкции, является отдельной исполнимой сущностью и применим везде, где применима единичная инструкция. 329 | 330 | По умолчанию все переменные глобальные, но при помощи слова `local` можно явным образом определять переменные, доступные только внутри блока. 331 | 332 | ```lua 333 | a = 1 334 | do 335 | local a = 10 336 | print(a) --> 10 337 | b = 2 338 | end 339 | print(a) --> 1 340 | print(b) --> 2 341 | ``` 342 | 343 | Блоки могут быть вложенными. Во внутренних блоках локальные переменные внешних доступны так же, как и глобальные. При создании внутри блока глобальной переменной она будет доступна везде. 344 | 345 | ## Управление потоком 346 | 347 | Программа - это набор действий, выполняемых последовательно. В теории автоматов любую программу можно представить в виде графа, где есть начальное, конечное и множество промежуточных состояний, по которым переходит исполнитель, выполняя инструкции. Поток выполнения - это маршрут, которым исполнитель добирается от начальной до конечной точки. 348 | 349 | А команды управляющие этим маршрутом называются инструкциями управления потоком. Что позволяет вложить в программу множество маршрутов, которые будут зависеть от разных факторов. 350 | 351 | ## Безусловный переход 352 | 353 | Есть разные мнения по поводу инструкции `goto`, но иногда она действительно полезна. Она имеет неудобный синтаксис и массу ограничений - нельзя "впрыгивать" внутрь блока, "выпрыгивать" из функции и "впрыгивать" внутрь области видимости локальной переменной. Это сделано намеренно - чтобы не возникало желания ею пользоваться без насущной необходимости. 354 | 355 | ```lua 356 | do 357 | a = 0 358 | ::loop:: -- имя метки подчиняется тем же правилам, что и имена переменных 359 | a = a + 1 -- это не блок, отступы просто для читаемости 360 | if a % 2 == 0 then goto continue end 361 | if a > 100 then goto exit end -- прыгать внутрь области видимости переменной нельзя 362 | print (a) 363 | ::continue:: 364 | goto loop 365 | local b = -a 366 | ::exit:: 367 | -- но если после метки до конца области видимости ничего нет, то можно 368 | end 369 | ``` 370 | 371 | ## Условия 372 | 373 | Программа не всегда должна делать одно и то же. 374 | 375 | В зависимости от условий поток выполнения может разделяться на ветки, поэтому условное выполнение называется ветвлением. Каждая ветка может разделяться ещё на ветки и так далее. 376 | 377 | ```lua 378 | if a > 0 then 379 | print ("'a' is positive") -- если выполняется уловие 380 | end 381 | 382 | if b > 0 then 383 | print ("'b' is positive") 384 | else 385 | print ("'b' is NOT positive") -- есть не выполняется 386 | end 387 | 388 | if c > 0 then 389 | print ("'c' is positive") 390 | elseif c < 0 then -- это вместо switch-case, elseif-ов может быть много 391 | print ("'c' is negative") 392 | else 393 | print ("'c' is zero") 394 | end 395 | ``` 396 | 397 | ## Циклы 398 | 399 | Циклы нужны для многократного повторения одинаковых действий. 400 | 401 | Цикл с предусловием проверяют условие повторения и выполняют блок, пока оно истинно. Циклы с постусловием сначала выполняют блок, а потом проверяют, достигнуто ли условие завершения. 402 | 403 | ```lua 404 | while false do 405 | print ('Hello?') 406 | end -- не выполнится ни разу 407 | 408 | repeat 409 | print ('yes, hello!') 410 | until true -- выполнится один раз 411 | ``` 412 | 413 | Цикл с выходом из середины не имеют граничных условий, поэтому в блоке необходимо явным образом предусмотреть выход. При помощи `break` можно "выпрыгнуть" из цикла, функции и вообще из любого блока. Нет `continue`, но его можно реализовать с помощью `goto`. 414 | 415 | ```lua 416 | a = 0 417 | while true do 418 | ::continue:: 419 | a = a + 2 420 | if a == 13 then -- правильно выбирайте условие выхода из цикла! 421 | break 422 | end 423 | if a % 10 == 0 then goto continue end -- пропускаем всё, кратное 10 424 | print (a) 425 | end 426 | ``` 427 | 428 | В цикле со счётчиком некоторая переменная изменяет своё значение от заданного начального значения до конечного значения с некоторым шагом, и для каждого значения этой переменной блок выполняется один раз. 429 | 430 | ```lua 431 | for i = 0,9,1 do -- если шаг равен 1, третий параметр можно пропустить 432 | print(i) 433 | end 434 | print(i) --> nil; счетчик является локальной переменной и снаружи не доступен 435 | ``` 436 | 437 | Совместный цикл задает выполнение некоторой операции для объектов из множества. 438 | 439 | ```lua 440 | x = {4, 8, 15, 16, 23, 42} 441 | for k,v in ipairs(x) 442 | print ('code #'..k..' is '..v) 443 | end 444 | print(k,v) --> nil nil 445 | ``` 446 | 447 | ## Функции 448 | 449 | В последнем примере `ipairs()` это функция. И не просто функция, а итератор. Она получает таблицу и при первом вызове возвращает её первое значение, а при последующих - второй, третье и так далее. 450 | 451 | Работает она примерно так: 452 | 453 | ~~~lua 454 | x = {4, 8, 15, 16, 23, 42} 455 | function values(t) 456 | local i = 0 457 | return function() 458 | i = i + 1 459 | return t[i] -- мы могли бы возвращать еще и i, но ipairs у нас уже есть 460 | end 461 | end 462 | for v in values(x) do -- обратите внимание, что здесь мы тоже обходимся без ключа 463 | print (v) 464 | end 465 | ~~~ 466 | 467 | Этот коротенький пример сразу дает нам массу информации. 468 | 469 | Во-первых, функции являются значениями первого класса. То есть их можно присваивать переменным, передавать параметром в другие функции и использовать в качестве возвращаемого значения. 470 | 471 | ```lua 472 | sum = function (a,b) 473 | return a + b 474 | end 475 | print (sum (2,2)) --> 4 476 | 477 | function mul (a, b) -- более привычный способ записи всего лишь "семантический сахар" 478 | return a*b 479 | end 480 | print (mul (2,2)) --> 4 481 | ``` 482 | 483 | Во-вторых, значение не знает имя переменной, в котором оно содержится. Таким образом все функции анонимны. Но не всегда... 484 | 485 | ~~~lua 486 | function fact(n) 487 | if n == 0 then return 1 else return n*fact(n-1) end 488 | end 489 | ~~~ 490 | 491 | В-третьих, возвращаемых значений может быть несколько. Не один, не два, а столько, сколько захочет вернуть функция. Если при этом мы используем множественное присваивание, то можем получить все значения. Если имен переменных меньше - то "лишние" значения будут отброшены. А если больше - то они получат `nil`. 492 | 493 | Ну, и четвертых, функция является блоком со своей областью видимости для локальных переменных, имея доступ к переменным глобальным. А, будучи объявлена внутри другого блока, локальные переменные внешнего блока воспринимает как глобальные. Это и позволяет нам создавать замыкания - то есть функции, сохраняющие контекст. Весь контекст, без уточнений. Будьте благоразумны и не создавайте лишние сущности. 494 | 495 | Кстати, кроме `ipairs`в стандартной библиотеке Lua есть еще `pairs` - более общий итератор, который позволяет работать с любыми таблицами, не только с массивами. Но в случае с массивами мы получим значения не по возрастанию ключей, а произвольно. 496 | 497 | ## Сопрограммы 498 | 499 | Прежде, чем мы перейдем к сопрограммам (для вас, любители англицизмов, это "корутины"), несколько слов о многозадачности. 500 | 501 | Мы уже говорили об графе состояний, исполнителе и потоке выполнения. В многозадачном алгоритме исполнителей несколько и у каждого из них - свое состояние и свой путь в графе состояний. Многопоточные алгоритмы - просто другое название для многозадачных. 502 | 503 | Не так важно, выполняются ли потоки разными физическими процессорами или разными потоками одного, переключаются ли они операционной системой, "главным" потоком или явно передают управление друг другу - главное, что каждый поток (строго говоря "нить", от английского "thread" - для англоманов "тред") имеет свое состояние. 504 | 505 | В Lua реализована "совместная многопоточность", когда потоки явно уступают выполнение друг другу и сохраняют состояние до следующего момента, когда выполнение столь же явно будет передано им снова. Никакого разделения на физические процессоры или совместного использования процессорного времени. Никакой вытесняющей многозадачности, неблокирующего доступа, семафором, диспетчеров. Только явная передача управление и сохранение состояния. Это логическая многозадачность - на самом деле в любой момент времени выполняется только один поток. Просто их несколько и они переключаются между собой. 506 | 507 | ~~~lua 508 | c = coroutine.create( 509 | function (t) 510 | local i = coroutine.yield("initialized") 511 | repeat 512 | i = coroutine.yield(t[i]) 513 | until not t[i] 514 | return "finished" 515 | end 516 | ) 517 | print (c,coroutine.status(c)) --> thread: 0x416e52a8 suspended 518 | s = {2,3,5,7,11,13,17,19} 519 | print (coroutine.resume(c,s)) --> true initialized 520 | print (coroutine.resume(c,1)) --> true 2 521 | print (coroutine.resume(c,3)) --> true 5 522 | print (coroutine.resume(c,9)) --> true finished 523 | print (c,coroutine.status(c)) --> thread: 0x416e52a8 dead 524 | print (coroutine.resume(c,5)) --> false cannot resume dead coroutine 525 | ~~~ 526 | 527 | В этом примере описан весь функционал сопрограмм. Давайте разберемся с ним, шаг за шагом. 528 | 529 | Вызов `corutine.create` получает функцию и возвращает спящую ("suspended") сопрограмму. Её можно "разбудить" вызовом `coroutine.resume` и тогда она начинает выполняться. 530 | 531 | Выполняется она до тех пор, пока не встретиться вызов `coroutine.yield`. В этот момент управление возвращается к вызывающему потоку. Следующий вызов `coroutine.resume` восстановит выполнение сопрограммы, передавая управление ровно в то место, где она была приостановлена. 532 | 533 | Сопрограмма может быть вечной - если она время от времени уступает выполнение, то в какой-то момент её можно просто не возобновить. Но она может и завершится и перейти в состояние "dead", возобновить из которого её будет уже невозможно. 534 | 535 | Вызовы `.resume` и `.yield` могут не только передавать управление, но и обмениваться данными. В примере первый вызов `.resume` передает сопрограмме таблицу простых чисел, как если бы она передавалась функции в параметре, два других вызова передают данные внутрь сопрограммы, а она, в свою очередь, передает при помощи `.yield` обратно запрашиваемые значение из таблицы. При попытке получить значение за пределами таблицы сопрограмма заканчивается и возвращает сообщение при помощи `return`, как самая заурядная функция. 536 | 537 | Вот, собственно, и все. Эта простая реализация дает возможность реализовывать многозадачные алгоритмы даже не в многозадачной среде. Впрочем, никто не мешает вам создать на С приложение на с "настоящей" многопоточностью и запустить по виртуальной машине в каждом потоке, предоставив им возможность вызывать специально написанные потокобезопасные функции вашего приложения. 538 | 539 | ## ООП, "которого нет" 540 | 541 | Структура с методами это простейший вариант объекта. Метод это функция, сохраненная в элементе таблицы. 542 | 543 | ```lua 544 | a = { 545 | name = "Nick", 546 | sayHello = function (t) 547 | print ("Hello, "..t.name) 548 | end 549 | } 550 | a.sayHello(a) --> Hello, Nick 551 | a:sayHello() --> Hello, Nick 552 | ``` 553 | 554 | Обратите внимание на две последние строчки. Они выполняют одно и то же, но по разному. 555 | 556 | Чтобы функция знала, с какой таблицей она работает, ей это надо сообщить. В первом случае таблица явно передается параметром, во втором (когда используется двоеточие вместо точки) имя таблицы неявно передается первым параметром. 557 | 558 | Есть несколько способов определять методы. 559 | 560 | ```lua 561 | a = { 562 | name = "Nick", 563 | whoami = function (t) -- метод можно определить сразу в таблице 564 | return t.name 565 | end 566 | } 567 | -- а можно и отдельно от неё 568 | function a.hello(t,name) -- здесь таблица передается в явном виде 569 | local me = name or t.whoami() 570 | print("Hello, "..me) 571 | end 572 | 573 | function a:bye(name) 574 | local me = name or self.name -- а здесь появляется "магическая" переменная self 575 | print("Goodbye, "..me) 576 | end 577 | 578 | -- способ вызова метода не зависит от того, как он был определен 579 | a:hello() --> Hello, Nick 580 | a.bye(a) --> Goodbye, Nick 581 | a.hello(a,"John") --> Hello, John 582 | a:bye("John") --> Goodbye, John 583 | print(a:whoami()) --> Nick 584 | ``` 585 | 586 | Все это тоже семантический сахар. 587 | 588 | ## Метатаблицы 589 | 590 | Латинское "meta" буквально означает "после" в том смысле, в каком слово "метафизика" означает "не только физика". Метатаблица способна менять обычное поведение других таблиц. 591 | 592 | ```lua 593 | a,b = {},{} 594 | setmetatable (a,b) -- назначаем одну таблицу метатаблицей для другой 595 | print (getmetatable (a) == b) --> true 596 | 597 | b.x = 2 598 | 599 | print (a.x) --> 1 600 | print (getmetatable(a).x) --> 2 601 | ``` 602 | 603 | Что же нам это дает? В описанном примере - практические ничего. Вся сила метатаблиц в метаметодах. 604 | 605 | ## Метаметоды 606 | 607 | Это "магические" методы, которые позволяют менять существующее поведение таблицы. "Магические" они потому, что их логика зависит от того, как они называются. 608 | 609 | ```lua 610 | t = { 611 | a = 42 612 | } 613 | print (t.a) --> 42 614 | print (t.b) --> nil; стандартное поведение таблицы 615 | -- создадим метатаблицу с измененной логикой 616 | mt = { 617 | -- этот метод вызывается при чтении несуществующей переменной 618 | __index = function (t,k) 619 | return k.." : ключ отсуствует" 620 | end 621 | } 622 | setmetatable (t,mt) -- задаем метатаблицу для нашей таблицы и повторяем те же действия 623 | -- теперь таблица ведет себя иначе 624 | print (t.a) --> 42 625 | print (t.b) --> b: ключ отсуствует" 626 | ``` 627 | 628 | Если вы попытаетесь прочесть из таблицы значение по несуществующему ключу, вы получите `nil`. Но если у таблицы есть метатаблица, а в ней - метод ``__index``, то будет вызван он. 629 | 630 | ```lua 631 | t, mt = {}, {} 632 | t.a.b = 42 -- ошибка: t.a равно nil, а не пустая таблица 633 | -- определяем новую логику 634 | function mt:__index(k) 635 | self[k] = {} 636 | setmetatable (self[k], mt) 637 | return self[k] 638 | end 639 | setmetatable (t,mt) -- и применяем её к нашей таблице 640 | t.a.b.l.e = 42 -- больше никаких проблем с таблицами любой вложенности 641 | print (t.a.b.l.e) --> 42 642 | ``` 643 | 644 | Наследование: 645 | 646 | ```lua 647 | n = {name = "Nick"} 648 | j = {name = "John"} 649 | m = { 650 | __index = m, -- если присвоить этому методу таблицу, поиск ключа будет вестить в ней 651 | hello = function (t) 652 | print ("Hello, "..t.name) 653 | end 654 | } 655 | setmetatable(n,m) 656 | setmetatable(j,m) 657 | n:hello() --> ошибка: вы пытаетесь вызвать метод 'hello' (а он равен nil) 658 | ``` 659 | 660 | **Внимание! Это красивый, но неправильный пример.** 661 | 662 | И дело тут не в том, что `__index` вместо функции является таблицей (для этого "магического" метода это допустимо). И не в том, что элемент таблицы ссылается на саму таблицу - это тоже нормально. Просто до завершения объявления таблицы она не существует и метод `__index` не к чему "привязывать". 663 | 664 | А вот правильный вариант: 665 | 666 | ```lua 667 | n = {name = "Nick"} 668 | j = {name = "John"} 669 | m = { -- сначала создаем метатаблицу 670 | hello = function (t) 671 | print ("Hello, "..t.name) 672 | end 673 | } 674 | m.__index = m -- потом назначаем её 675 | setmetatable(n,m) 676 | setmetatable(j,m) 677 | n:hello() --> Hello, Nick 678 | j:hello() --> Hello, John 679 | ``` 680 | 681 | Здесь мы затрагиваем одну интересную особенность. Пока элемент не определен - он недоступен. Возможно, стоило бы разрешить "ранее связывание", чтобы первый вариант тоже был рабочим. Возможно, это даже будет сделано в будущем, но это уж как решит профессор Иерусалемски - автор и "пожизненный великодушный диктор" Lua. 682 | 683 | Впрочем, для функций милостиво сделано исключение. 684 | 685 | ```lua 686 | --[[ специально определяем функцию как переменную, 687 | чтобы быть увереным, что тут нет никакого "скрытого сахара" ]] 688 | fact = function (n) 689 | if n == 1 then 690 | return 1 691 | else 692 | return n * fact(n-1) -- формально определение функции еще не завершено 693 | end 694 | end 695 | print (fact(5)) --> 120; тем не менее, все работает (но только начиная с версии 5.3) 696 | ``` 697 | 698 | Не индексом единым... 699 | 700 | ```lua 701 | m = { 702 | __index = function (t,k) 703 | print ("Чтение "..k) 704 | return t[k] 705 | end, 706 | __nexindex = function (t,k,v) 707 | print ("Запись "..k) 708 | t[k] = v 709 | end 710 | } 711 | a = {x = 12} 712 | setmetatable (a,m) 713 | print (a.x) --> 12 714 | a.y = 1 --[[ операция уходит в бесконечный цикл и завершается, 715 | когда интерпретатор это понимает]] 716 | ``` 717 | 718 | (**простите, но это был еще один неправильный пример**) 719 | 720 | Вопреки ожиданиям, программа ведет себя не так, как ожидалось. Это потому, что при обращении к таблице **сначала** выполняется обращение к элементам, а потом (если их нет) идет поиск "альтернативной логики" в метатаблице (опять же, если она есть). 721 | 722 | Если элементы существуют, интерпретатору нет необходимости обращаться к метаметодам. Но мы можем "вынудить" его это делать. 723 | 724 | ```lua 725 | m = { 726 | __index = function (t,k) 727 | print ("Чтение "..k) 728 | return t.data[k] 729 | end, 730 | __newindex = function (t,k,v) 731 | print ("Запись "..k) 732 | t.data[k] = v 733 | end 734 | } 735 | a = {data = {}} 736 | 737 | setmetatable (a,m) 738 | a.x = 12 --> Запись x 739 | print (a.x) --> Чтение x 740 | --> 12 741 | a.y = 1 --> Запись y 742 | print (a.z) --> Чтение z 743 | --> nil 744 | ``` 745 | 746 | Мы переносим значения таблицы в таблицу внутри таблицы. Этот прием позволяет перехватывать все операции чтения и записи в таблицу и менять их. 747 | 748 | Или не позволять получать элементы, который мы посчитаем закрытыми, как в "классическом" ООП. Хотя на этот счет профессор высказался предельно ясно: "если вам нужны приватные свойства, **просто не обращайтесь к ним**". 749 | 750 | ## Арифметические метатметоды 751 | 752 | - `__add`: сложение (`+`) 753 | - `__sub`: вычитание (`-`) 754 | - `__mul`: умножение (`*`) 755 | - `__div`: деление (`/`) 756 | - `__mod`: остаток от деления (`%`) 757 | - `__pow`: возведение в степень (`^`) 758 | - `__unm`: унарный (одноместный) минус (`-`) 759 | - `__idiv`: целочисленное деление (`//`) 760 | 761 | В общем случае, если операнды не числа и не строки (которые можно преобразовать в числа), то при выполнении операции будут искаться метаметоды сначала в первом (левом) операнде, а затем во втором (правом). Как только метаметод будет найден, ему передадутся оба операнда, а результат выполнения будет обрезан до одного значения. Иначе будет выдана ошибка. 762 | 763 | Обратите внимание на то, что если нужный метаматод будет найдет во втором операнде, они все равно будут переданы **в том порядке, в котором записаны в выражении**. Эту ситуацию нужно предвидеть и корректно обработать. 764 | 765 | ## Логические метаметоды 766 | 767 | - `__band`: битовое И (`&`) 768 | - `__bor`: битовое ИЛИ (`|`) 769 | - `__bxor`: битовое ИЛИ-НЕ (`~`) 770 | - `__bnot`: битовое одноместное НЕ (`~`) 771 | - `__shl`: битовый сдвиг влево (`<<`) 772 | - `__shr`: битовый сдвиг вправо (`>>`) 773 | 774 | Логика схожая. 775 | 776 | ## Строковые метаметоды 777 | 778 | - `__concat`: конкатенация (`..`) 779 | - `__len`: длина (`#`) 780 | 781 | Разница в том, что метаметоды будут использоваться, если аргументы не строки и не числа (которые можно привести к строкам). Если в таблице отсутствует реализация `__len` , то будет вызвана стандартная функция `#`, а она, как мы помним, не везде применима. 782 | 783 | ## Метаметоды сравнения 784 | 785 | - `__eq`: равенство (`==`) 786 | - `__lt`: меньше (`<`) 787 | - `__le`: меньше или равно (`<=`) 788 | 789 | Тут немного веселее. Во-первых, оба операнда должны быть таблицами. Во-вторых, при встрече операций "больше" и "больше или равно", они предварительно будут "перевернуты" в "меньше" и "меньше или равно". В-третьих, результат будет преобразован к логическому типу (то есть к значениям true или false) 790 | 791 | ## Метаметоды доступа 792 | 793 | - `__index`: чтение из таблицы 794 | - `__newindex`: запись в таблицу нового значения 795 | - `__call`: обращение к таблице как к функции 796 | - `__gc`: выполняется перед уничтожением таблицы сборщиком мусора 797 | 798 | Тут надо заметить, что первые два метода вызываются только при обращении к отсутствующим элементам таблицы. Эти методы получают в параметрах саму таблицу и ключ. 799 | 800 | Третий метод очень удобен в качестве "конструктора" - метода по умолчанию. Он получает в параметрах таблицу, за которой следуют все оригинальные аргументы вызова. Ну, а последний метод можно использовать в качестве "деструктора". 801 | 802 | ## Перегрузка операций 803 | 804 | Если при выполнении арифметической операции один из операндов является таблицей, то произойдет ошибка. Но с целой "колодой" метаметодов в рукаве мы можем это изменить. 805 | 806 | Если один из операндов сложения является таблицей, интерпретатор будет искать метод `__sum` в его метатаблице. Если оба операнда отвечают этим требованиям - будет использован метаметод первого (левого) операнда. 807 | 808 | ```lua 809 | odd = {1,3,5,7,9} -- таблица нечетных чисел 810 | even = {2,4,6,8} -- таблица четных чисел 811 | set = { 812 | __add = function (a,b) -- передаются операдны операции сложения 813 | if type(b) ~= "table" then -- операнд может не быть таблицей 814 | a[#a + 1] = b -- тогда просто добавляем его ко множеству 815 | else -- в противном случае 816 | for _,v in pairs (b) do 817 | a[#a + 1] = v -- добавляем по одному все элементы этой таблицы 818 | end 819 | end 820 | return a 821 | end 822 | } 823 | setmetatable(odd,set) -- превращаем таблицы во "множества" 824 | setmetatable(even,set) 825 | even = even + 10 -- будьте осторожны, ситуацию "even = 10 + even" мы не предусмотрели 826 | for _,v in pairs(odd + even) do 827 | print(v) -- сумма множеств представляем собой множество всех элементов подмножеств 828 | end 829 | ``` 830 | 831 | Исходя их постулата "таблица это объект" можно реализовать перегрузку всех арифметических и логических операций, чтения и записи, вызова функции... но все это работает только для таблиц - мета-таблицы нельзя назначать никаким другим типам данных. Это сделано специально, чтобы не давать слишком много возможностей "выстрелить себе в ногу". 832 | 833 | ## Стандартная библиотека 834 | 835 | В Lua граница между языком и библиотеками очень четкая. Все, что не касается непосредственно языка, вынесено в стандартную библиотеку. Можно собрать Lua без нее и тогда ваша программа не сможет даже вывести на экран строку "привет, мир". Что является огромным преимуществом при использовании Lua внутри другого приложения в качестве встроенного языка, который должен уметь только то, что ему позволено и не оставит скрипту ни малейшего шанса "выбраться из песочницы". 836 | 837 | Стандартный библиотек немного и функционал их не впечатляет. Причина в том, что во имя переносимости в стандартных библиотеках есть только то, что может быть реализовано на всех платформах, где есть ANSI C. Все остальные библиотеки так или иначе являются сторонними. 838 | 839 | ## Модули 840 | 841 | Принцип повторного использования кода подразумевает, что написанный функционал может быть использован повторно. Примем необязательно автором. Отчуждаемый код - это модули, пакеты, библиотеки, все то, благодаря чему нам не нужно каждый раз писать все самим. Девиз "все уже ~~украдено~~ написано до нас" особенно близок адептам Python-а, но не чужд и нам. 842 | 843 | ```lua 844 | local lunajson = require 'lunajson' -- теперь мы умеет работать с JSON 845 | 846 | local jsonstr = '{"Hello":["lunajson",1.5]}' 847 | local t = lunajson.decode(jsonstr) 848 | print(t.Hello[2]) --> 1.5 849 | print(lunajson.encode(t)) --> {"Hello":["lunajson",1.5]} 850 | ``` 851 | 852 | Разумеется, не все так просто. Для того, чтобы использовать пакет, он должен присутствовать в одном из мест, где его будет искать `require`. 853 | 854 | В переменной `package.path` содержится строка с вариантами шаблона путей для поиска. Вы можете увидеть из при помощи команды `print`. 855 | 856 | ```lua 857 | > print (package.path) 858 | /usr/share/lua/5.3/?.lua;/usr/share/lua/5.3/?/init.lua;/usr/lib/lua/5.3/?.lua;/usr/lib/lua/5.3/?/init.lua;./?.lua;./?/init.lua 859 | ``` 860 | 861 | Подставьте вместо вопросительного знака имя модуля - и у вас будет список всех возможных файлов, который будет пытаться открыть команда `require`. 862 | 863 | Это обычная переменная и её можно переопределить или дополнить прямо в программе. И после этого команда `require` будет исходить их её нового значения. 864 | 865 | Проще всего разместить подключаемый модуль в той же директории, что и ваша программа. Создайте файл с именем `module.lua` и впишите в него следующее: 866 | 867 | ```lua 868 | local complex = { 869 | __add = function (x, y) 870 | return {a = x.a + y.a, b = x.b + y.b} 871 | end, 872 | __tostring = function (z) 873 | -- этот метаметод вызывается, когда с таблицей пытаются обращаться, как со строкой 874 | return z.a..'+'..z.b..'i' 875 | end 876 | } 877 | return function (a, b) 878 | z = {a = a, b = b} 879 | setmetatable (z, { 880 | __index = complex 881 | }) 882 | return z 883 | end 884 | ``` 885 | 886 | Теперь в своей программе вы можете написать так: 887 | 888 | ```lua 889 | local complex = require "complex" 890 | 891 | x = complex(3,2) 892 | y = complex(4,5) 893 | print (x + y) -- вот здесь перед выводом выполняется метатметод __tostring 894 | ``` 895 | 896 | ## Пакеты 897 | 898 | Имя модуля может содержать точки. При поиске модуля точка превращается в разделитель директории (прямая косая черта для Linux и обратная - для Windows, операционные системы без иерархической файловой системы могут использовать знак подчеркивания). Пакет - это все дерево модулей в одной директории. 899 | 900 | Глубина вложенности не важна, дерево пакета может быть довольно разветвленным. Модули пакета являются автономными и связаны только логически. 901 | 902 | А если вы снова внимательно посмотрите на значение переменной `package.path`, то увидите там такую подстроку: 903 | 904 | ~~~ 905 | ./?/init.lua 906 | ~~~ 907 | 908 | Это позволяет загружать пакет, в модуле `init.lua` которого будет выполняться загрузка его компонентов или другие действия инициализации. 909 | 910 | ## Заключение 911 | 912 | Теперь вы знаете, что такое Lua. Теперь переходите к "Программирование на Lua", той самой книге, о которой мы говорили в самом начале. Если вы решили включить Lua в свой инструментальный набор, эта книга станет для вас настольной. В том числе и потому, что в ней автор рассказывает, что и почему в Lua реализовано именно так, а не иначе. 913 | 914 | А еще - там есть такой громадный пласт материала, как встраивание в приложение на C и взаимодействие к кодом, написанным на C. Я посчитал, что для "маленькой книги" это слишком глубокий материал. 915 | 916 | Мы также обошли стороной `luarocks` - это пакетный менеджер, который Hisham Muhammad написал и поддерживает с 2006 года. Это не единственный менеджер пакетов, но для Lua он стал стандартом "де-факто". Строго говоря, он не является частью языка, поэтому я не стал его описывать. Так же, как ZeroBrane Studio, которая является великолепной IDE и удачным примером приложения, полностью написанного на Lua. 917 | 918 | Засим откланиваюсь. 919 | Спасибо, что дочитали. 920 | 921 | --------------------------------------------------------------------------------