commit 5ca45f298c482e7ab749d85beeb29995ce1c8363 Author: Lucas Schwiderski Date: Sun Mar 27 20:02:52 2022 +0200 chore: Initialize repository diff --git a/.busted.lua b/.busted.lua new file mode 100644 index 0000000..3aa0614 --- /dev/null +++ b/.busted.lua @@ -0,0 +1,7 @@ +return { + default = { + verbose = true, + helper = "./spec/_helper.lua", + lpath = "./src/?.lua;./src/?/init.lua;./src/?/?.lua;./tests/?.lua", + }, +} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..ee8cc00 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,79 @@ +name: Lint & Test + +on: + push: + branches: [ master, staging, trying ] + pull_request: + branches: [ master ] + +env: + CI: true + DEBIAN: noninteractive + +jobs: + check: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v2.4.0 + - uses: leafo/gh-actions-lua@v8.0.0 + - uses: leafo/gh-actions-luarocks@v4.0.0 + + - name: Install LuaCheck + run: luarocks install luacheck + + - name: Run checks + run: make check LUA_VERSION=${{ matrix.lua_version }} + + test: + runs-on: ubuntu-20.04 + strategy: + fail-fast: false + matrix: + include: + - lua_version: '5.1' + - lua_version: '5.2' + - lua_version: '5.3' + - lua_version: 'luajit' + steps: + - uses: actions/checkout@v2.4.0 + - uses: leafo/gh-actions-lua@v8.0.0 + with: + luaVersion: ${{ matrix.lua_version }} + - uses: leafo/gh-actions-luarocks@v4.0.0 + + - name: Install dependencies + shell: /bin/bash -o errexit -o pipefail -o xtrace {0} + run: | + sudo apt-get update + sudo apt-get install -y --no-install-recommends gobject-introspection libgirepository1.0-dev libpulse-dev + luarocks install busted + luarocks install lgi + + - name: Run tests + run: make test LUA_VERSION=${{ matrix.lua_version }} + + rock: + runs-on: ubuntu-20.04 + needs: [test, check] + strategy: + fail-fast: false + matrix: + include: + - lua_version: '5.1' + - lua_version: '5.2' + - lua_version: '5.3' + steps: + - uses: actions/checkout@v2.4.0 + - uses: leafo/gh-actions-lua@v8.0.0 + with: + luaVersion: ${{ matrix.lua_version }} + - uses: leafo/gh-actions-luarocks@v4.0.0 + + - name: Install dependencies + shell: /bin/bash -o errexit -o pipefail -o xtrace {0} + run: | + sudo apt-get update + sudo apt-get install -y --no-install-recommends gobject-introspection libgirepository1.0-dev + + - name: Make rock + run: make rock LUA_VERSION=${{ matrix.lua_version }} diff --git a/.github/workflows/deploy-to-pages.yml b/.github/workflows/deploy-to-pages.yml new file mode 100644 index 0000000..51176b0 --- /dev/null +++ b/.github/workflows/deploy-to-pages.yml @@ -0,0 +1,34 @@ +name: Deploy docs + +on: + push: + branches: ['master'] + +env: + DEBIAN: noninteractive + +jobs: + deploy-docs: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v2.4.0 + - uses: leafo/gh-actions-lua@v8.0.0 + - uses: leafo/gh-actions-luarocks@v4.0.0 + - uses: actions/setup-node@v2 + with: + node-version: 'lts/*' + + - name: Install dependencies + run: | + luarocks install ldoc + luarocks install lua-discount + npm install --global sass + + - name: Generate documentation + run: make doc + + - name: Deploy to gh-pages + uses: JamesIves/github-pages-deploy-action@v4.2.5 + with: + branch: gh-pages + folder: out/doc diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a06c9da --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +out/ +.sass-cache +.vscode/*.log diff --git a/.luacheckrc b/.luacheckrc new file mode 100644 index 0000000..7804f8b --- /dev/null +++ b/.luacheckrc @@ -0,0 +1,11 @@ +std = "max" + +ignore = { + "431", + "432" +} + +files[".luacheckrc"].std = "+luacheckrc" +files["rocks/*.rockspec"].std = "+rockspec" + +files["tests/*_spec.lua"].std = "+busted" diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json new file mode 100644 index 0000000..0b51fe3 --- /dev/null +++ b/.vscode/c_cpp_properties.json @@ -0,0 +1,21 @@ +{ + "configurations": [ + { + "name": "Linux", + "includePath": [ + "${workspaceFolder}/src/lua_libpulse_glib/**", + "/usr/include/lua5.3", + "/usr/include/glib-2.0", + "/usr/lib/glib-2.0/include", + "/usr/lib/x86_64-linux-gnu/glib-2.0/include", + "/usr/include/gobject-introspection-1.0" + ], + "defines": [], + "compilerPath": "/usr/bin/gcc", + "cStandard": "c11", + "cppStandard": "c++14", + "intelliSenseMode": "linux-clang-x64" + } + ], + "version": 4 +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..db3ee7e --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,10 @@ +{ + "C_Cpp.errorSquiggles": "Enabled", + "files.associations": { + "**/tasks/*.yml": "ansible", + "*.rockspec": "lua", + "*.ld": "lua", + "glib-mainloop.h": "c", + "lua.h": "c" + } +} diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..3727afb --- /dev/null +++ b/Makefile @@ -0,0 +1,86 @@ +PROJECT = lua_libpulse_glib +PREFIX ?= /usr/local +BUILD_DIR = out + +LUA_VERSION ?= 5.3 +LUA ?= $(shell command -v lua$(LUA_VERSION)) +LUA_BINDIR ?= /usr/bin +# LUA_LIBDIR ?= /usr/lib +LUA_INCDIR ?= /usr/include/lua$(LUA_VERSION) + +INSTALL_BINDIR ?= $(PREFIX)/bin +INSTALL_LIBDIR ?= $(PREFIX)/lib/lua/$(LUA_VERSION) +INSTALL_LUADIR ?= $(PREFIX)/share/lua/$(LUA_VERSION) +INSTALL_CONFDIR ?= $(PREFIX)/etc + +CC = gcc +PKG_CONFIG ?= $(shell command -v pkg-config) + +PKGS = glib-2.0 gobject-2.0 lua$(LUA_VERSION) + +CFLAGS ?= -fPIC +LIBFLAG ?= -shared + +CCFLAGS ?= $(CFLAGS) +CCFLAGS += -Wall -g $(shell $(PKG_CONFIG) --cflags $(PKGS)) -I$(LUA_INCDIR) + +LIBS = -L"$(LUA_LIBDIR)" -L$(shell dirname "$(shell $(CC) -print-libgcc-file-name)") +LIBS += $(shell $(PKG_CONFIG) --libs $(PKGS)) +OBJS = $(shell find src -type f -iname '*.c' | sed 's/\(.*\)\.c$$/$(BUILD_DIR)\/\1\.so/') + +ifdef CI +CHECK_ARGS ?= --formatter TAP +TEST_ARGS ?= --output=TAP + +CCFLAGS += -Werror +endif + +.PHONY: clean doc doc-content doc-styles install test check rock + +build: $(OBJS) + +$(BUILD_DIR)/%.o: %.c + @mkdir -p $(shell dirname "$@") + $(CC) -c $(CCFLAGS) $< -o $@ + +%.so: %.o + $(CC) $(LIBFLAG) -o $@ $< $(LIBS) + +doc-styles: + @printf "\e[1;97mGenerate stylesheet\e[0m\n" + sass doc/ldoc.scss $(BUILD_DIR)/doc/ldoc.css + +doc-content: + @mkdir -p "$(BUILD_DIR)/doc" "$(BUILD_DIR)/src" + @printf "\e[1;97mPreprocess sources\e[0m\n" + sh tools/process_docs.sh "$(BUILD_DIR)" + @printf "\e[1;97mGenerate documentation\e[0m\n" + ldoc --config=doc/config.ld --dir "$(BUILD_DIR)/doc" --project $(PROJECT) "$(BUILD_DIR)/src" + +doc: doc-content doc-styles +ifdef CI + touch "$(BUILD_DIR)/doc/.nojekyll" +endif + +clean: + rm -r out/ + +install: build doc + @printf "\e[1;97mInstall C libraries\e[0m\n" + find $(BUILD_DIR)/src -type f -iname '*.so' | xargs install -vDm 644 -t $(INSTALL_LIBDIR)/$(PROJECT) + + @printf "\e[1;97mInstall Lua libraries\e[0m\n" + find src/ -type f -iname '*.lua' | xargs install -vDm 644 -t $(INSTALL_LUADIR)/$(PROJECT) + + @printf "\e[1;97mInstall documentation\e[0m\n" + install -vd $(PREFIX)/share/doc/$(PROJECT) + cp -vr $(BUILD_DIR)/doc/* $(PREFIX)/share/doc/$(PROJECT) + +check: + find src/ -iname '*.lua' | xargs luacheck $(CHECK_ARGS) + +test: + busted --config-file=.busted.lua --lua=$(LUA) $(TEST_ARGS) + +rock: + luarocks --local --lua-version $(LUA_VERSION) make rocks/lua-libpulse-glib-scm-1.rockspec diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..10ac33a --- /dev/null +++ b/README.adoc @@ -0,0 +1,45 @@ += lua-libpulse-glib +:idprefix: +:idseparator: - +ifdef::env-github,env-browser[] +:toc: macro +:toclevels: 1 +endif::[] +ifdef::env-github[] +:branch: master +:status: +:outfilesuffix: .adoc +:!toc-title: +:caution-caption: :fire: +:important-caption: :exclamation: +:note-caption: :paperclip: +:tip-caption: :bulb: +:warning-caption: :warning: +endif::[] +:url-ci-github: https://github.com/sclu1034/lua-libpulse-glib/actions +:url-ci-badge-github: https://img.shields.io/github/workflow/status/sclu1034/lua-libpulse-glib/Lint%20&%20Test?style=flat-square +:url-license-badge: https://img.shields.io/badge/license-GPLv3-brightgreen?style=flat-square +:url-luarocks-badge: https://img.shields.io/luarocks/v/sclu1034/lua-libpulse-glib?style=flat-square +:url-luarocks-link: https://luarocks.org/modules/sclu1034/lua-libpulse-glib + +image:{url-license-badge}[License] +ifdef::status[] +image:{url-ci-badge-github}[Build Status (GitHub Actions), link={url-ci-github}] +endif::[] +image:{url-luarocks-badge}[LuaRocks Package, link={url-luarocks-link}] + +https://freedesktop.org/software/pulseaudio/doxygen/index.html[libpulse] bindings for use with a GLib MainLoop via +https://github.com/lgi-devs/lgi/[LGI]. + +== Installation + +_lua-libpulse-glib_ is available via LuaRocks: + +[source,shell] +---- +luarocks install lua-libpulse-glib +---- + +When cloning/vendoring the library, the following dependencies are required: + +* https://github.com/lgi-devs/lgi[lgi] diff --git a/bors.toml b/bors.toml new file mode 100644 index 0000000..85d5802 --- /dev/null +++ b/bors.toml @@ -0,0 +1,10 @@ +status = [ + "check", + "test (5.1)", + "test (5.2)", + "test (5.3)", + "test (luajit)", + "rock (5.1)", + "rock (5.2)", + "rock (5.3)", +] diff --git a/doc/config.ld b/doc/config.ld new file mode 100644 index 0000000..c990afc --- /dev/null +++ b/doc/config.ld @@ -0,0 +1,28 @@ +project = 'lgi-async-extra' +title = 'lgi-async-extra' +description = 'An asynchronous high(er)-level API wrapper for lua-lgi' + +template = true + +format = 'discount' + +pretty = 'lua' +prettify_files = 'show' +backtick_references = false +wrap = true +no_space_before_args = true + +custom_tags = { + { + "async", + hidden = true, + }, + { + "repository", + hidden = true, + }, + { + "package", + hidden = true, + } +} diff --git a/doc/ldoc.ltp b/doc/ldoc.ltp new file mode 100644 index 0000000..6843759 --- /dev/null +++ b/doc/ldoc.ltp @@ -0,0 +1,303 @@ + + + + + + + $(ldoc.title) + + + + +# local function M(txt, item) return ldoc.markup(txt, item, ldoc.plain) end +# -- LDoc doesn't expose this, even though it does expose `pairs`. *insert confused face* +# local function next(tbl) +# local n, t = ldoc.pairs(tbl) +# return n(t) +# end + + +
+# if ldoc.body then -- verbatim HTML as contents; 'non-code' entries +
+
$(ldoc.body)
+
+# elseif module then +
+
+

$(ldoc.module_typename(module)) $(module.name)

+

$(M(module.summary, module))

+
+

$(M(module.description, module))

+
+# if module.info or next(module.tags) then +
+# for tag, value in module.info:iter() do +
+
+ $(tag) + $(M(value, module)) +
+
+# end +
+# end +
+
+# if not ldoc.no_summary then +
+
+

Table of contents

+# for kind, items in module.kinds() do +

$(kind)

+ + +# for item in items() do + + + + +# end + +
$(ldoc.display_name(item))$(M(item.summary, item))
+# end +
+
+# end + +# for kind, items in module.kinds() do +# local kitem = module.kinds:get_item(kind) +# local has_description = kitem and ldoc.descript(kitem) ~= "" +
+
+

$(kind)

+# local section_description = module.kinds:get_section_description(kind) +# if section_description then +
$(M(section_description, nil))
+# end +# if has_description then +
+ $(M(ldoc.descript(kitem), kitem)) +
+# end +
+# for item in items() do +
+
+ $(ldoc.display_name(item)) +# if ldoc.prettify_files and ldoc.is_file_prettified[item.module.file.filename] then + line $(item.lineno) +# end +# if item.tags["async"] then + async +# end +
+ +
$(M(ldoc.descript(item), item))
+ +# if not ldoc.no_return_or_params then +# if item.params and #item.params > 0 then +
+# local subnames = module.kinds:type_of(item).subnames +# if subnames then +

$(subnames):

+# end +
    +# for parm in ldoc.modules.iter(item.params) do +# local param,sublist = item:subparam(parm) +# if sublist then +
  • $(sublist)$(M(item.params.map[sublist], item)) +
      +# end +# for p in ldoc.modules.iter(param) do +# local name = item:display_name_of(p) +# local type_name = ldoc.typename(item:type_of_param(p)) +# local default = item:default_of_param(p) +
    • +
      + $(name) +# local description = item.params.map[p] +# if description and description ~= "" then + : $(M(description, item)) +# end +
      +
      +# if type_name ~= '' then +
      +
      + type + $(type_name) +
      +
      +# end +# if default == true then +
      +
      + optional +
      +
      +# elseif default then +
      +
      + default + $(default) +
      +
      +# end +# if item:readonly(p) then +
      +
      + readonly +
      +
      +# end +
      +
      • +# end +# if sublist then +
    +# end +# end + +
+
+# end +# if item.retgroups then +# -- I only need a single return group for now +# local group = item.retgroups[1] +
+# if item.tags["async"] then +

Callback parameters:

+# else +

Returns:

+# end +
    +# for r in group:iter() do +
  • +# local description = r.text +# if description and description ~= "" then +
    + $(M(description, item)) +
    +# end +# local t, ctypes = item:return_type(r) +# local rt = ldoc.typename(t) +# local optional = false +# if rt:match("optional ") then +# optional = true +# rt = rt:match("optional (.*)") +# end +
    +
    +
    + type + $(rt) +
    +
    +# if optional then +
    +
    + optional +
    +
    +# end +
    +
    • +# end +
+
+# end +# end +# if item.usage then +
+

Usage:

+# for usage in ldoc.modules.iter(item.usage) do + 
$(ldoc.prettify(usage))
+# end +
+# end +
+# end +
+
+
+# end +# else -- elseif module -> project-level content +
+
+

$(ldoc.project)

+# if ldoc.description then +

$(M(ldoc.description, nil))

+# end +# if ldoc.full_description then +
+

$(M(ldoc.full_description,nil))

+
+# end +
+
+ +
+
+# for kind, mods in ldoc.kinds() do +# kind = kind:lower() +

$(kind)

+ + +# for m in mods() do + + + + +# end + +
$(m.name)$(M(ldoc.strip_header(m.summary), m))
+# end +
+
+# end +
+ + + + + diff --git a/doc/ldoc.scss b/doc/ldoc.scss new file mode 100644 index 0000000..0e62c3f --- /dev/null +++ b/doc/ldoc.scss @@ -0,0 +1,71 @@ +@import 'scss/bulma/sass/base/all'; +@import 'scss/bulma/sass/helpers/all'; +@import 'scss/bulma/sass/utilities/all'; + +@import 'scss/bulma/sass/components/menu'; + +// Required for single-line tags +@import 'scss/bulma/sass/form/shared'; +@import 'scss/bulma/sass/form/tools'; + +@import 'scss/bulma/sass/elements/box'; +@import 'scss/bulma/sass/elements/container'; +@import 'scss/bulma/sass/elements/content'; +@import 'scss/bulma/sass/elements/table'; +@import 'scss/bulma/sass/elements/tag'; +@import 'scss/bulma/sass/elements/title'; + +@import 'scss/bulma/sass/layout/footer'; +@import 'scss/bulma/sass/layout/section'; + +@import 'scss/syntax'; + +:root { + --sidebar-width: 15rem; +} + +.block { + @extend %block; +} + +#sidebar { + position: fixed; + top: 0; + bottom: 0; + width: var(--sidebar-width); + + padding: .5em; + + box-shadow: 1px 0 2px hsl(0, 0%, 48%); +} + +#content { + margin-left: var(--sidebar-width); +} + +.source-ref { + float: right; +} + +.section__item > div:not(:first-child) { + margin-left: 1em; +} + +.section__item__title > .tag { + vertical-align: bottom; +} + +.parameter .parameter__tags { + margin-top: .25em; +} + +.menu-list a:not(.is-active):hover { + background-color: var(--lt-color-white); +} + +.parameter__type, +.return-value__type { + .type { + font-weight: bold; + } +} diff --git a/doc/scss/_syntax.scss b/doc/scss/_syntax.scss new file mode 100644 index 0000000..cba8c17 --- /dev/null +++ b/doc/scss/_syntax.scss @@ -0,0 +1,64 @@ +pre, +.code-block.code-block--lua { + .comment { + color: #558817; + } + + .constant { + color: #a8660d; + } + + .escape { + color: #844631; + } + + .keyword { + color: #aa5050; + font-weight: bold; + } + + .library { + color: #0e7c6b; + } + + .marker { + color: #512b1e; + background: #fedc56; + font-weight: bold; + } + + .string { + color: #8080ff; + } + + .number { + color: #f8660d; + } + + .operator { + color: #2239a8; + font-weight: bold; + } + + .preprocessor, + .prepro { + color: #a33243; + } + + .global { + color: #800080; + } + + .user-keyword { + color: #800080; + } + + .prompt { + color: #558817; + } + + .url { + color: #272fc2; + text-decoration: underline; + } +} diff --git a/doc/scss/bulma/CHANGELOG.md b/doc/scss/bulma/CHANGELOG.md new file mode 100644 index 0000000..543531a --- /dev/null +++ b/doc/scss/bulma/CHANGELOG.md @@ -0,0 +1,1558 @@ +# Bulma Changelog + +## 0.9.3 + +### New features + +- New `is-underlined` class for underlined text and links +- New `auto` value for margin and padding helper classes + +### Improvements + +- New `$section-padding-desktop` Sass variable +- New `$hero-body-padding-tablet` Sass variable +- New `$shadow` Sass variable (used for `.box`, `.card`, `.dropdown` and `.panel`) +- Add `is-normal` size modifiers to `.file` and `.content` +- New `%reset` placeholder + +### Bugfix + +- #3362 Fix slash divide + +## 0.9.2 + +### Breaking change + +To fix duplicate imports, all Sass placeholders have moved from the `utilities/mixins` file to its own `utilities/extends` file. + +The Sass placeholders are: + +- `%control` +- `%unselectable` +- `%arrow` +- `%block` +- `%delete` +- `%loader` +- `%overlay` + +If you were importing them directly from `utilities/mixins`, you'll need to import `utilities/extends` instead. +If you were importing `utilities/_all` or even `bulma.sass` directly, no change is required. + +### New features + +- Fix #1583 New `is-ghost` button that behaves / looks like a regular link +- New `icon-text` component, to combine an icon with text on its side + +### Bug fixes + +- #3005 Fix `column` offsets in RTL +- Fix #3145 Dropdown content is bounded by a parent card +- Fix #3089 Sub columns of a variable columns have weird gap +- Fix #2937 Add `width: unset` for narrow columns +- #3208 Fix #3163 Do not override is-rounded with button-small +- #3216 Removed duplicate `mixins` imports, created a single `extends` file +- #3216 Removed all references to the `.sass` file extension have been removed, since they're unnecessary when there's no ambiguity between a `.sass` file or a `.scss` file + +### Improvements + +- Fix #3012 Add `$media-*` variables, set to `!default` +- Fix #2797 Import dependencies individually for each component +- Remove list style from pagination list + +## 0.9.1 + +### New features + +- #3047 Flexbox helpers +- #3085 Add `is-clickable` helper +- #3086 Allow each component to have its own colors and default to global ones +- New variables `$navbar-colors`, `$button-colors`, `$notification-colors`, `$progress-colors`, `$table-colors`, `$tag-colors`, `$file-colors`, `$textarea-colors`, `$select-colors`, `$form-colors`, `$label-colors` and `$hero-colors` + +### Improvements + +- #2630 Fixes #2598 -> Add `$card-radius` variable +- Add `$card-overflow` variable +- #2540 Fixes #2539 -> Fix indeterminate progress styling in IE11 +- #3057 Make the default text color of `$code` listings more accessible +- #3088 Adds not allowed cursor to missing inputs +- #3101 Add `$modal-breakpoint` variable for modal breakpoint +- #3107 Add `optgroup` to `generic.sass` + +## 0.9.0 + +### Deprecation warning + +The `base/helpers.sass` file is **deprecated**. It has moved into its own `/helpers` folder. If you were importing `base/helpers.sass` or `base/_all.sass`, please import `sass/helpers/_all.sass` now. +If you were simply importing the whole of Bulma with `@import "~/bulma/bulma.sass"` or similar, you won't have to change anything, and everything will work as before. + +The `list` component is also **deprecated**: the `components/list.sass` file has been deleted. It was never officially supported as it was too similar to `panel` component. Use that one instead. + +### RTL support + +Bulma now has **RTL support**. + +By setting the Sass flag `$rtl` to `true`, you can create an RTL version of Bulma, thanks to 4 new Sass mixins: + +- `=ltr` +- `=rtl` +- `=ltr-property($property, $spacing, $right: true)` +- `=ltr-position($spacing, $right: true)` + +The Bulma package now also comes with a `bulma-rtl.css` and `bulma-rtl.min.css` file to be used straight away. + +### Spacing helpers + +Bulma now has **spacing helpers**: https://bulma.io/documentation/helpers/spacing-helpers/ + +

Bulma provides margin m* and padding p* helpers in all directions:

+ +
    +
  • + *t for top +
    • +
  • + *r for right +
    • +
  • + *b for bottom +
    • +
  • + *l for left +
    • +
  • + *x horizontally for both left and right +
    • +
  • + *y vertically for both top and bottom +
    • +
+ +

+ You need to combine a margin/padding prefix with a direction suffix. For example: +

+ +
    +
  • for a margin-top, use mt-*
    • +
  • for a padding-bottom, use pb-*
    • +
  • for both margin-left and margin-right, use mx-*
    • +
+ +

+ Each of these property-direction combinations needs to be appended with one of 6 value suffixes +

+ +This release also includes the following helpers: + +- light and dark color helpers +- light and dark background color helpers + +### Improvements + +- #2925 Center table cell content vertically with `is-vcentered` + +### Bug fixes + +- #2955 Fix issue when there's only one `is-toggle` tag + +## 0.8.2 + +### Bug fixes + +- Fix #2885 -> Revert `$input-color: $text-strong` + +## 0.8.1 + +### Improvements + +- #2709 Add light colors to the `notification` element +- #2740 Fixes #2739 -> Add variables size for layout `hero` +- Fix #2741 -> Create `bulmaRgba()` function to support `inherit` value +- #2756 Add `$button-text-decoration` variable + +### Bug fixes + +- #2664 Fixes #2671 -> Add `$panel-colors` variable + +## 0.8.0 + +### Big update + +#### Larger form controls + +Controls and buttons are now `2.5em` high. You can revert this resizing by setting these previous values: + +```sass +$control-height: 2.25em +$control-padding-vertical: calc(0.375em - #{$control-border-width}) +$control-padding-horizontal: calc(0.625em - #{$control-border-width}) +$button-padding-vertical: calc(0.375em - #{$button-border-width}) +$button-padding-horizontal: 0.75em +``` + +#### Light and dark colors + +Each main color (`"primary"`, `"info"`, `"success"`, `"warning"`, `"danger"`) now has a `*-light` and `*-dark` version. They are calculated using 2 new color functions: + +- `findLightColor()` which finds the light version of a color +- `findDarkColor()` which finds the dark version of a color + +The light colors are used by the `button` element, while the light and dark colors are used by the `message` component. + +#### Panel colors + +The `panel` component is now available in all the different colors. + +#### 4-value color map + +The `$colors` Sass map now accepts, for each of its values, a map of up to **4** values. For example: the key `"info"` now has the `($info, $info-invert, $info-light, $info-dark)` map. + +If you provide a `$custom-colors` map, you can decide to provide a map of 1, 2, 3 or 4 values for each value. If fewer than 4 are provided, Bulma will calculate the remaining ones: + +```scss +$custom-colors: ( + 'lime': ( + lime, + ), + 'tomato': ( + tomato, + white, + ), + 'orange': ( + $orange, + $orange-invert, + $orange-light, + ), + 'lavender': ( + $lavender, + $lavender-invert, + $lavender-light, + $lavender-dark, + ), +); +``` + +This is processed by the updated `mergeColorMaps()` Sass function. + +#### Scheme variables + +There are 6 new `$scheme` derived variables: `$scheme-main` `$scheme-main-bis` `$scheme-main-ter` `$scheme-invert` `$scheme-invert-bis` `$scheme-invert-ter` +They replace the `$white` and `$black` occurrences in the codebase. This makes it easy to create a "Dark mode" simply by swapping the values: + +```sass +$scheme-main: $black +$scheme-invert: $white +// etc. +``` + +That is also why most of the codebase now references **derived** variables (`$text`, `$background`, `$border` etc.) instead of **initial** ones (`$grey`, `$grey-lighter`, `$grey-darker` etc.): updating the derived variables will affect all elements and components directly. + +#### Initial variables + +- `$green: hsl(141, 53%, 53%)` +- `$cyan: hsl(204, 71%, 53%)` +- `$red: hsl(348, 86%, 61%)` + +#### Derived variables + +- `$primary-invert: findColorInvert($primary)` +- `$primary-light: findLightColor($primary)` +- `$primary-dark: findDarkColor($primary)` +- `$info-invert: findColorInvert($info)` +- `$info-light: findLightColor($info)` +- `$info-dark: findDarkColor($info)` +- `$success-invert: findColorInvert($success)` +- `$success-light: findLightColor($success)` +- `$success-dark: findDarkColor($success)` +- `$warning-invert: findColorInvert($warning)` +- `$warning-light: findLightColor($warning)` +- `$warning-dark: findDarkColor($warning)` +- `$danger-invert: findColorInvert($danger)` +- `$danger-light: findLightColor($danger)` +- `$danger-dark: findDarkColor($danger)` +- `$light-invert: findColorInvert($light)` +- `$dark-invert: findColorInvert($dark)` + +- `$scheme-main: $white` +- `$scheme-main-bis: $white-bis` +- `$scheme-main-ter: $white-ter` +- `$scheme-invert: $black` +- `$scheme-invert-bis: $black-bis` +- `$scheme-invert-ter: $black-ter` + +### Other variables + +- `$control-height: 2.5em` +- `$control-padding-vertical: calc(0.5em - #{$control-border-width})` +- `$control-padding-horizontal: calc(0.75em - #{$control-border-width})` +- `$media-border-color: rgba($border, 0.5)` +- `$notification-code-background-color: $scheme-main` +- `$panel-radius: $radius-large` +- `$panel-shadow: 0 0.5em 1em -0.125em rgba($scheme-invert, 0.1), 0 0px 0 1px rgba($scheme-invert, 0.02)` +- `$textarea-padding: $control-padding-horizontal` +- `$textarea-max-height: 40em` +- `$textarea-min-height: 8em` + +### Bug fixes + +- Fix #2647 -> Missing meta tags in snippet +- Fix #2031, Fix #2483 -> Invalid output when declaring a custom shade map +- Fix #2060 -> `height: auto` on HTML `audio` element breaks height of element +- Fix #706 -> Derive `-invert` variables using `findColorInvert()` +- #1608 Fix #1552 -> `.container.is-fluid` margins + +### New features + +- #2563 `.image` has a new `.is-fullwidth` modifier + +## 0.7.5 + +### Deprecation warning + +The `form.sass` file is **deprecated**. It has moved into its own `/form` folder. If you were importing `form.sass`, please import `sass/form/_all.sass` now. +If you were simply importing the whole of Bulma with `@import "~/bulma/bulma.sass"` or similar, you won't have to change anything, and everything will work as before. + +### New features + +#### Support for overriding the `font-family` + +You can now specify a different `font-family` for the `.title`, `.subtitle` and `.button` by using the variables `$title-family`, `$subtitle-family` and `$button-family` respectively. + +Simply set a value when importing Bulma: + +```scss +$title-family: 'Georgia', serif; +``` + +- #2375 Add `.is-relative` helper +- #2321 Make `.navbar` focus behave like hover for the navigation +- #2290 Fix #1186 -> Reset the offset on columns +- #2231 Add `.has-text-weight-medium` helper +- #2224 Add customizable border radius to progress bar +- #2480 Add `$footer-color` variable + +### Improvements + +- #2396 Update docs with webpack 4 example +- #2381 Make centered buttons have equal margin +- Fix #2297 -> Remove `.container` fixed width values, use `flex-grow` +- #2478 Move form.sass into its own folder + +### Bug fixes + +- #2420 Fix #2414 -> Fix `align` attribute in `td/th` being ignored +- #2463 Remove duplicate `.has-addons` in `tag.sass` +- #2253 Fix `$gap` variable default value +- #2273 Fix #2258 -> Fix Indeterminate Progress Bar animation in Firefox +- #2175 Proper aligning for `.tabs` within `.content` +- #2476 Fix #2441 -> Correct active pagination link text color on hero + +Fix #1979 -> Correct loading spinner color when a button is: + +- outlined and hovered/focused +- outlined, inverted and hovered/focused + +### New variables + +#### Initial variables + +- `$block-spacing` + +#### Base + +- `$body-font-size` +- `$small-font-size` +- `$pre-font-size` +- `$pre-padding` +- `$pre-code-font-size` + +#### Components + +- `$card-header-padding` +- `$card-content-padding` +- `$card-media-margin` +- `$dropdown-menu-min-width` +- `$dropdown-content-padding-bottom` +- `$dropdown-content-padding-top` +- `$level-item-spacing` +- `$menu-list-line-height` +- `$menu-list-link-padding` +- `$menu-nested-list-margin` +- `$menu-nested-list-padding-left` +- `$menu-label-font-size` +- `$menu-label-letter-spacing` +- `$menu-label-spacing` +- `$pagination-item-font-size` +- `$pagination-item-margin` +- `$pagination-item-padding-left` +- `$pagination-item-padding-right` +- `$panel-margin` +- `$panel-tabs-font-size` + +#### Elements + +- `$container-offset` + +#### Grid + +- `$tile-spacing` + +## 0.7.3 + +### New features + +- #2145 Fix #372 -> New indeterminate progress bars +- #2206 Fix #2046 -> New variables `$table-head-background-color`, `$table-body-background-color` and `$table-foot-background-color` for the `.table` element +- #592 -> Give arbitrary elements access to the image/ratio classes +- #1682 Fix #1681 -> Adds disabled styles for `
` +- #2201 Fix #1875 -> `.buttons` and `.tags` group sizing (`.are-small`, `.are-medium`, `.are-large`) + +### Improvements + +- #1978 Fix #1696 -> Force `box-sizing: border-box` on `details` element +- #2167 Fix #1878 -> New `$footer-padding` variable +- #2168 -> New `$input-placeholder-color` and `$input-disabled-placeholder-color` variables + +### Bug fixes + +- #2157 Fix #1656 -> Allow border radius if only one `.control` in `.field` +- #2091 Fix #2091 -> Remove CSS rule which causes `.tag.has-addons` to not work correctly +- #2186 Fix #1130 -> Prevent `.dropdown` links underlining in `.message` component +- Fix #2154 -> Move `.hero.is-fullheight-with-navbar` to `navbar.sass` file + +### Deprecation + +- `.control.has-icon` deprecated in favor of `.control.has-icons` + +## 0.7.2 + +### New features + +- #1884 New `$navbar-burger-color` variable +- #1679 Add breakpoint based column gaps +- #1905 Fix `modal` for IE11 #1902 +- #1919 New `is-arrowless` class for navbar items +- #1949 New `is-fullheight-with-navbar` class for heros +- #1764 New `.is-sr-only` helper +- #2109 Add and use `$navbar-breakpoint` variable +- New variables `$control-height`, `$control-line-height`, `$pagination-min-width`, `$input-height` +- #1720 Add list element feature +- #2123 Add `.content ol` types: `.is-lower-roman`, `.is-upper-roman`, `.is-lower-alpha`, `.is-upper-alpha`, and support for the `type=` HTML attribute + +### Improvements + +- #1964 Allow `.notification` to have a `.dropdown-item` +- #1999 Change `$border` to `$grey-lighter` in mixins +- #2085 `.media-content` will allow scrolling horizontally if the content is too wide +- #1744 Fix #1710 by using `$table-striped-row-even-hover-background-color` only for even rows +- #2074 Allow `