├── .elpaignore ├── .gitignore ├── .travis.yml ├── COPYING ├── Makefile ├── README.org ├── pg_type.h ├── pq-compile.el ├── pq-core.c ├── pq-test.el └── pq.el /.elpaignore: -------------------------------------------------------------------------------- 1 | pq-test.el 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.so 2 | #*# 3 | 4 | *.elc 5 | /pq-autoloads.el 6 | /pq-pkg.el 7 | 8 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: c 2 | dist: trusty 3 | sudo: false 4 | services: 5 | - postgresql 6 | addons: 7 | postgresql: 9.5 8 | apt: 9 | sources: 10 | - precise-pgdg-9.5 11 | packages: 12 | - libpq-dev 13 | env: 14 | global: 15 | - EMACSCONFFLAGS="--with-x-toolkit=no --without-x --without-all --with-xml2 --with-modules" 16 | matrix: 17 | - EMACS_VERSION=25.3 18 | - EMACS_VERSION=26.2 19 | - EMACS_VERSION=snapshot 20 | matrix: 21 | allow_failures: 22 | - env: EMACS_VERSION=snapshot 23 | before_install: 24 | - export PATH="$HOME/bin:$PATH" 25 | - curl -fsSOL https://github.com/flycheck/emacs-travis/raw/master/emacs-travis.mk 26 | - make -f emacs-travis.mk install_emacs 27 | - make -f emacs-travis.mk install_cask 28 | - curl -OL https://github.com/emacs-mirror/emacs/raw/emacs-25.1/src/emacs-module.h 29 | install: 30 | - make 31 | before_script: 32 | - psql -c 'create database travis_ci_test;' -U postgres 33 | script: 34 | - make PG_CONNINFO="user=postgres dbname=travis_ci_test" check 35 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | EMACS = emacs 2 | EMACS_VERSION := $(shell $(EMACS) -q --batch --eval "(princ emacs-version)") 3 | EMACS_MAJOR_VERSION := $(shell $(EMACS) -q --batch --eval "(princ emacs-major-version)") 4 | EMACS_INCLUDE_DIR := $(wildcard /usr/include/emacs-$(EMACS_MAJOR_VERSION)*) 5 | EMACS_SRC_DIR := /usr/share/emacs/$(EMACS_VERSION) 6 | 7 | PG_CONFIG = pg_config 8 | PGINCLUDEDIR := $(shell $(PG_CONFIG) --includedir) 9 | 10 | CC = gcc 11 | CFLAGS = -I$(CURDIR) -I$(EMACS_INCLUDE_DIR) -I$(EMACS_SRC_DIR) -I$(PGINCLUDEDIR) -std=gnu99 -ggdb3 -Wall -fPIC 12 | LDFLAGS = -lpq 13 | 14 | ifeq ($(OS),Windows_NT) 15 | TARGET = pq-core.dll 16 | else 17 | TARGET = pq-core.so 18 | endif 19 | 20 | all: $(TARGET) 21 | 22 | %.so: %.o 23 | $(LD) -shared $(LDFLAGS) -o $@ $< 24 | 25 | %.o: %.c 26 | $(CC) $(CFLAGS) -c $< 27 | 28 | clean: 29 | $(RM) $(TARGET) 30 | 31 | check: $(TARGET) 32 | $(EMACS) --batch -Q -l ert -l pq-test.el -f ert-run-tests-batch-and-exit 33 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | An Emacs 25 module for accessing PostgreSQL via the libpq client library. 2 | 3 | Using libpq for client connections has various advantages over the 4 | wire-protocol speaking pure elisp implementations. For example, it 5 | has better performance and supports all features of the protocol like 6 | full TLS support and new authentication methods like scram-sha-256. 7 | 8 | It doesn't expose many libpq features yet, but what's there should be 9 | crash-safe no matter what you do in the lisp world. I've been using 10 | it for three years now for reading mail through my custom Gnus backend 11 | without incidents. If you make it crash, please report. 12 | 13 | * Basic usage 14 | : ELISP> (setq *pq* (pq:connectdb "dbname=andreas")) 15 | : # 16 | : ELISP> (pq:query *pq* "select version()") 17 | : ("PostgreSQL 9.6.7 on x86_64-pc-linux-gnu, compiled by gcc (Debian 6.3.0-18) 6.3.0 20170516, 64-bit") 18 | : ELISP> (pq:query *pq* "create table local_variables(name text, value text)") 19 | : nil 20 | : ELISP> (dolist (el (buffer-local-variables)) 21 | : (pq:query *pq* "insert into local_variables values ($1, $2)" 22 | : (car el) (cdr el))) 23 | : nil 24 | : ELISP> (pq:query *pq* "select name, length(value) from local_variables where value ~ 'mode'") 25 | : (["major-mode" 24] 26 | : ["change-major-mode-hook" 86] 27 | : ["hi-lock-mode-major-mode" 24] 28 | : ["eldoc-mode-major-mode" 24] 29 | : ["font-lock-major-mode" 24] 30 | : ["font-lock-mode-major-mode" 24]) 31 | 32 | * Error Handling 33 | =pq= raises SQL errors as error signal =pq:error=. This provides the 34 | [[https://www.postgresql.org/docs/current/errcodes-appendix.html][SQLSTATE]] error code in an additional string in the error data list. 35 | For example, you can reliably catch unique violations like this: 36 | 37 | : (condition-case err (pq:query *pq* "insert into t values (666)") 38 | : (pq:error 39 | : (if (string= "23505" (nth 2 err)) 40 | : (progn 41 | : (message "Caught a unique violation")) 42 | : ;; re-throw anything else 43 | : (signal (car err) (cdr err))))) 44 | 45 | * Conversion of data types from SQL to Emacs Lisp 46 | =pq= converts bigints and numerics your queries return to lisp floats 47 | because they don't fit into a lisp integer. This looses precision on 48 | big values. If you need the full precision, cast them to =text= and 49 | use, e.g., =calc-eval= to do arbitrary precision things with them. 50 | All other data types are returned as utf-8 strings. 51 | 52 | * Conversion of data types from Emacs Lisp to SQL 53 | Strings and the query text itself is converted to utf-8 by the module 54 | interface. If this conversion fails, the behavior is undefined by the 55 | module interface. If you want to send strings that are not valid 56 | utf-8, you need to work around this. For example, I'm using code like 57 | the following to store raw bytes into a table with a =bytea= column: 58 | 59 | : (pq:query *con* 60 | : "insert into t (blob) values (decode($1, 'base64'))" 61 | : (base64-encode-string my-random-bytes)) 62 | 63 | Any non-string parameter to pq:query is turned into an emacs string 64 | using =prin1-to-string= first. This works quite well to store 65 | arbitrary lisp data and read it back with =read=. All other aspects 66 | of =prin1-to-string= apply too. For example, when =print-length= or 67 | =print-level= are set to non-nil, these would be applied as well. 68 | 69 | * Notifications 70 | After a [[https://www.postgresql.org/docs/current/sql-listen.html][=LISTEN=]] statement, PostgreSQL will deliver notifications 71 | asynchronously over the connection. Since the emacs-module interface 72 | does not allow for asynchronous callbacks, you have to check for these 73 | periodically after a =LISTEN= statement by calling =pq:notifies=. 74 | Calling it will not cause any traffic on the connection itself. 75 | 76 | See the testsuite [[./test.el]] for more implemented features. 77 | 78 | [[https://api.travis-ci.org/anse1/emacs-libpq.svg]] 79 | -------------------------------------------------------------------------------- /pg_type.h: -------------------------------------------------------------------------------- 1 | /*------------------------------------------------------------------------- 2 | * 3 | * pg_type.h 4 | * Hard-wired knowledge about some standard type OIDs. 5 | * 6 | * SPDX-License-Identifier: GPL-3.0-or-later 7 | * 8 | * XXX keep this in sync with src/include/catalog/pg_type.h 9 | * 10 | * Portions Copyright (c) 1996-2016, PostgreSQL Global Development Group 11 | * Portions Copyright (c) 1994, Regents of the University of California 12 | * 13 | * src/interfaces/ecpg/ecpglib/pg_type.h 14 | * 15 | *------------------------------------------------------------------------- 16 | */ 17 | #ifndef PG_TYPE_H 18 | #define PG_TYPE_H 19 | 20 | #define BOOLOID 16 21 | #define BYTEAOID 17 22 | #define CHAROID 18 23 | #define NAMEOID 19 24 | #define INT8OID 20 25 | #define INT2OID 21 26 | #define INT2VECTOROID 22 27 | #define INT4OID 23 28 | #define REGPROCOID 24 29 | #define TEXTOID 25 30 | #define OIDOID 26 31 | #define TIDOID 27 32 | #define XIDOID 28 33 | #define CIDOID 29 34 | #define OIDVECTOROID 30 35 | #define POINTOID 600 36 | #define LSEGOID 601 37 | #define PATHOID 602 38 | #define BOXOID 603 39 | #define POLYGONOID 604 40 | #define LINEOID 628 41 | #define FLOAT4OID 700 42 | #define FLOAT8OID 701 43 | #define ABSTIMEOID 702 44 | #define RELTIMEOID 703 45 | #define TINTERVALOID 704 46 | #define UNKNOWNOID 705 47 | #define CIRCLEOID 718 48 | #define CASHOID 790 49 | #define INETOID 869 50 | #define CIDROID 650 51 | #define BPCHAROID 1042 52 | #define VARCHAROID 1043 53 | #define DATEOID 1082 54 | #define TIMEOID 1083 55 | #define TIMESTAMPOID 1114 56 | #define TIMESTAMPTZOID 1184 57 | #define INTERVALOID 1186 58 | #define TIMETZOID 1266 59 | #define ZPBITOID 1560 60 | #define VARBITOID 1562 61 | #define NUMERICOID 1700 62 | 63 | #endif /* PG_TYPE_H */ 64 | -------------------------------------------------------------------------------- /pq-compile.el: -------------------------------------------------------------------------------- 1 | ;;; pq-compile.el --- Compile the `pq-core` module -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2022 Free Software Foundation, Inc. 4 | 5 | ;; This program is free software; you can redistribute it and/or modify 6 | ;; it under the terms of the GNU General Public License as published by 7 | ;; the Free Software Foundation, either version 3 of the License, or 8 | ;; (at your option) any later version. 9 | 10 | ;; This program is distributed in the hope that it will be useful, 11 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | ;; GNU General Public License for more details. 14 | 15 | ;; You should have received a copy of the GNU General Public License 16 | ;; along with this program. If not, see . 17 | 18 | ;;; Commentary: 19 | 20 | ;; 21 | 22 | ;;; Code: 23 | 24 | (defvar pq--compile-directory 25 | (file-name-directory 26 | (or 27 | (if (fboundp 'macroexp-file-name) (macroexp-file-name)) ;Emacs≥28 28 | load-file-name 29 | buffer-file-name 30 | (locate-library "pq")))) 31 | 32 | (defun pq--compile-module () 33 | "Compile the `pq-core' module." 34 | (with-temp-buffer 35 | (setq default-directory pq--compile-directory) 36 | (let* ((exitcode (call-process "make" nil t))) 37 | (if (zerop exitcode) 38 | (message "Compilation of `pq-core' succeeded") 39 | (let ((out (buffer-string))) 40 | (if noninteractive 41 | (message "Compilation of `pq-core' failed:\n%s" out) 42 | (with-current-buffer (get-buffer-create "*pq-compile*") 43 | (setq default-directory pq--compile-directory) 44 | (let ((inhibit-read-only t)) 45 | (erase-buffer) 46 | (insert out)) 47 | (compilation-mode) 48 | (pop-to-buffer (current-buffer)) 49 | (error "Compilation of `pq-core' failed")))))))) 50 | 51 | (defun pq--compile-maybe () 52 | (cond 53 | (noninteractive ;; Batch use: try to compile but delay errors when possible. 54 | (ignore-errors (pq--compile-module)) 55 | (require 'pq-core nil t)) 56 | ;; FIXME: Should we first try it silently (i.e. without prompting the user)? 57 | ((not (y-or-n-p "PQ needs to compile the `pq-core' module. Do it now?")) 58 | (message "Continuing without `pq-core'; some operations may fail")) 59 | (t 60 | (pq--compile-module) 61 | (require 'pq-core)))) 62 | 63 | 64 | (provide 'pq-compile) 65 | ;;; pq-compile.el ends here 66 | -------------------------------------------------------------------------------- /pq-core.c: -------------------------------------------------------------------------------- 1 | /* libpq bindings for Emacs Lisp as a dynamic module 2 | 3 | Copyright (C) 2020-2022 Free Software Foundation, Inc. 4 | 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or (at 8 | your option) any later version. 9 | 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with this program. If not, see . */ 17 | 18 | 19 | #include 20 | #include 21 | #include "pg_type.h" 22 | #include 23 | #include 24 | #include 25 | #include 26 | 27 | #define MAX_PQ_PARAMS 12 28 | 29 | int plugin_is_GPL_compatible; 30 | 31 | #define Qnil env->intern(env, "nil") 32 | #define Qt env->intern(env, "t") 33 | 34 | #define NOTICE_FORMAT "pq: %s" 35 | 36 | static void pq_notice_rx (void *arg, const PGresult *res) 37 | { 38 | const char *msg = PQresultErrorMessage(res); 39 | emacs_env *env = arg; 40 | emacs_value Fmessage = env->intern (env, "message"); 41 | size_t len = strlen(msg); 42 | if (!len) 43 | return; 44 | emacs_value args [2] = { 45 | env->make_string(env, NOTICE_FORMAT, strlen(NOTICE_FORMAT)), 46 | env->make_string(env, msg, len-1 /* cut trailing newline */) 47 | }; 48 | env->funcall (env, Fmessage, 2, args); 49 | } 50 | 51 | static void pq_finalize_pointer(void *user_ptr) 52 | { 53 | PGconn *conn = user_ptr; 54 | PQfinish(conn); 55 | } 56 | 57 | /* Raise error unless a PGresult is ok. */ 58 | static bool result_ok(emacs_env *env, PGresult *res) 59 | { 60 | int status = PQresultStatus(res); 61 | switch (status) { 62 | case PGRES_NONFATAL_ERROR: 63 | case PGRES_TUPLES_OK: 64 | case PGRES_SINGLE_TUPLE: 65 | case PGRES_COMMAND_OK: 66 | return true; 67 | 68 | case PGRES_FATAL_ERROR: 69 | default: 70 | { 71 | const char *errmsg = PQresultErrorMessage(res); 72 | const char *sqlstate = PQresultErrorField(res, PG_DIAG_SQLSTATE); 73 | 74 | if (!sqlstate) 75 | sqlstate = "08006"; /* connection_failure */ 76 | 77 | emacs_value Qpq_error = env->intern (env, "pq:error"); 78 | emacs_value errmsg_string = 79 | env->make_string(env, errmsg, strlen(errmsg)); 80 | emacs_value sqlstate_string = 81 | env->make_string(env, sqlstate, strlen(sqlstate)); 82 | emacs_value errdata[] = {errmsg_string, sqlstate_string}; 83 | emacs_value errdata_list = 84 | env->funcall(env, env->intern(env, "list"), 2, errdata); 85 | 86 | PQclear(res); 87 | env->non_local_exit_signal(env, Qpq_error, errdata_list); 88 | } 89 | return false; 90 | } 91 | } 92 | 93 | /* Raise error unless a PGConn is ok. */ 94 | static bool connection_ok(emacs_env *env, PGconn *conn) 95 | { 96 | if (PQstatus(conn) != CONNECTION_OK) { 97 | const char *errmsg = PQerrorMessage(conn); 98 | emacs_value errstring = env->make_string(env, errmsg, strlen(errmsg)); 99 | emacs_value Qpq_error = env->intern (env, "error"); 100 | emacs_value errdata = env->funcall (env, env->intern(env, "list"), 1, &errstring); 101 | env->non_local_exit_signal(env, Qpq_error, errdata); 102 | return false; 103 | } 104 | return true; 105 | } 106 | 107 | static char *my_string_to_c(emacs_env *env, emacs_value string) 108 | { 109 | ptrdiff_t size; 110 | emacs_value teststring = env->make_string(env, "", 0); 111 | 112 | if (!env->eq(env, 113 | env->type_of(env, teststring), 114 | env->type_of(env, string))) { 115 | emacs_value Fprin1_to_string = 116 | env->intern(env, "prin1-to-string"); 117 | string = env->funcall(env, Fprin1_to_string, 118 | 1, &string); 119 | } 120 | 121 | env->copy_string_contents(env, string, 0, &size); 122 | char *buf = malloc(size); 123 | env->copy_string_contents(env, string, buf, &size); 124 | return buf; 125 | } 126 | 127 | static emacs_value 128 | Fpq_connectdb (emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data) 129 | { 130 | char *conninfo = nargs ? my_string_to_c(env, args[0]) : ""; 131 | PGconn *conn = PQconnectdb(conninfo); 132 | 133 | if (!connection_ok(env, conn)) { 134 | if (nargs) 135 | free(conninfo); 136 | PQfinish(conn); 137 | return Qnil; 138 | } 139 | 140 | /* The emacs-module interface always expects utf8 strings */ 141 | PGresult *res = 142 | PQexec(conn, 143 | "set client_encoding to utf8;" 144 | "set application_name to emacs;"); 145 | 146 | if (!result_ok(env, res)) { 147 | if (nargs) 148 | free(conninfo); 149 | PQfinish(conn); 150 | return Qnil; 151 | } 152 | 153 | PQclear(res); 154 | if (nargs) 155 | free(conninfo); 156 | 157 | return env->make_user_ptr(env, pq_finalize_pointer, conn); 158 | } 159 | 160 | static emacs_value 161 | pq_getvalue_internal(emacs_env *env, PGresult *res, int row, int column) 162 | { 163 | if (PQgetisnull(res, row, column)) 164 | return Qnil; 165 | 166 | char *result = PQgetvalue(res, row, column); 167 | if (!result) 168 | return Qnil; 169 | 170 | switch(PQftype(res, column)) { 171 | case BOOLOID: 172 | return ('t' == *result) ? Qt : Qnil; 173 | case INT2OID: 174 | case INT4OID: 175 | case OIDOID: 176 | return env->make_integer(env, atol(result)); 177 | case INT8OID: 178 | case FLOAT4OID: 179 | case FLOAT8OID: 180 | case NUMERICOID: 181 | return env->make_float(env, atof(result)); 182 | default: 183 | return env->make_string(env, result, strlen(result)); 184 | } 185 | } 186 | 187 | static emacs_value 188 | Fpq_query (emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data) 189 | { 190 | if (!env->is_not_nil(env, args[0])) 191 | return Qnil; 192 | PGconn *conn = env->get_user_ptr(env, args[0]); 193 | 194 | if (env->non_local_exit_check (env) != emacs_funcall_exit_return) 195 | return NULL; 196 | 197 | if (!connection_ok(env, conn)) { 198 | return Qnil; 199 | } 200 | 201 | int nParams = nargs - 2; 202 | 203 | char *command = my_string_to_c(env, args[1]); 204 | 205 | PQnoticeReceiver old_notice_rx = 206 | PQsetNoticeReceiver(conn, pq_notice_rx, env); 207 | 208 | PGresult *res; 209 | 210 | if (nParams) { 211 | const char *paramValues[nParams]; 212 | 213 | for (int i=0; iintern (env, "vector"); 240 | emacs_value Qcons = env->intern (env, "cons"); 241 | 242 | for (int t = ntuples-1; t >= 0; t--) { 243 | emacs_value tuple; 244 | if (1 == nfields) { 245 | tuple = pq_getvalue_internal(env, res, t, 0); 246 | } else if (0 == nfields) { 247 | tuple = Qnil; 248 | } else { 249 | emacs_value values[nfields+1]; 250 | for (int i = 0; i < nfields; i++) { 251 | values[i] = pq_getvalue_internal(env, res, t, i); 252 | } 253 | values[nfields] = Qnil; 254 | tuple = env->funcall (env, Qvector, nfields, values); 255 | } 256 | 257 | emacs_value args[2] = {tuple, list}; 258 | list = env->funcall (env, Qcons, 2, args); 259 | } 260 | 261 | PQsetNoticeReceiver(conn, old_notice_rx, NULL); 262 | PQclear(res); 263 | return list; 264 | } 265 | 266 | static emacs_value 267 | Fpq_escape (emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data) 268 | { 269 | if (!env->is_not_nil(env, args[0])) 270 | return Qnil; 271 | PGconn *conn = env->get_user_ptr(env, args[0]); 272 | 273 | if (env->non_local_exit_check (env) != emacs_funcall_exit_return) 274 | return NULL; 275 | 276 | char *value = my_string_to_c(env, args[1]); 277 | char *(*escaper)(PGconn *, const char *, size_t) = data; 278 | char *quoted = escaper(conn, value, strlen(value)); 279 | emacs_value result = env->make_string(env, quoted, strlen(quoted)); 280 | PQfreemem(quoted); 281 | return result; 282 | } 283 | 284 | static emacs_value 285 | Fpq_reset (emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data) 286 | { 287 | if (!env->is_not_nil(env, args[0])) 288 | return Qnil; 289 | PGconn *conn = env->get_user_ptr(env, args[0]); 290 | 291 | if (env->non_local_exit_check (env) != emacs_funcall_exit_return) 292 | return NULL; 293 | 294 | PQreset(conn); 295 | 296 | if (!connection_ok(env, conn)) { 297 | return Qnil; 298 | } 299 | 300 | return Qt; 301 | } 302 | 303 | static emacs_value 304 | Fpq_notifies (emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data) 305 | { 306 | PGconn *conn = env->get_user_ptr(env, args[0]); 307 | 308 | if (env->non_local_exit_check (env) != emacs_funcall_exit_return) 309 | return NULL; 310 | 311 | if (!connection_ok(env, conn)) { 312 | return NULL; 313 | } 314 | 315 | PQconsumeInput(conn); 316 | 317 | emacs_value Qvector = env->intern (env, "vector"); 318 | emacs_value Qcons = env->intern (env, "cons"); 319 | emacs_value result = Qnil; 320 | 321 | PGnotify *notify; 322 | while ((notify = PQnotifies(conn)) != NULL) 323 | { 324 | emacs_value vector_args[3]; 325 | vector_args[0] = env->make_string(env, notify->relname, strlen(notify->relname)); 326 | vector_args[1] = env->make_integer(env, notify->be_pid); 327 | vector_args[2] = env->make_string(env, notify->extra, strlen(notify->extra)); 328 | 329 | PQfreemem(notify); 330 | 331 | emacs_value cons_args[2]; 332 | cons_args[0] = env->funcall (env, Qvector, 3, vector_args); 333 | cons_args[1] = result; 334 | result = env->funcall (env, Qcons, 2, cons_args); 335 | } 336 | 337 | return result; 338 | } 339 | 340 | /* Bind NAME to FUN. */ 341 | static void 342 | bind_function (emacs_env *env, const char *name, emacs_value Sfun) 343 | { 344 | /* Set the function cell of the symbol named NAME to SFUN using 345 | the 'fset' function. */ 346 | 347 | /* Convert the strings to symbols by interning them */ 348 | emacs_value Qfset = env->intern (env, "fset"); 349 | emacs_value Qsym = env->intern (env, name); 350 | 351 | /* Prepare the arguments array */ 352 | emacs_value args[] = { Qsym, Sfun }; 353 | 354 | /* Make the call (2 == nb of arguments) */ 355 | env->funcall (env, Qfset, 2, args); 356 | } 357 | 358 | /* Provide FEATURE to Emacs. */ 359 | static void 360 | provide (emacs_env *env, const char *feature) 361 | { 362 | /* call 'provide' with FEATURE converted to a symbol */ 363 | 364 | emacs_value Qfeat = env->intern (env, feature); 365 | emacs_value Qprovide = env->intern (env, "provide"); 366 | emacs_value args[] = { Qfeat }; 367 | 368 | env->funcall (env, Qprovide, 1, args); 369 | } 370 | 371 | int 372 | emacs_module_init (struct emacs_runtime *ert) 373 | { 374 | emacs_env *env = ert->get_environment(ert); 375 | 376 | #define DEFUN(lsym, csym, amin, amax, doc, data) \ 377 | bind_function (env, lsym, \ 378 | env->make_function (env, amin, amax, csym, doc, data)) 379 | DEFUN("pq:connectdb", Fpq_connectdb, 0, 1, 380 | "Connect to a PostgreSQL database described by CONNINFO.\n" 381 | "\n" 382 | "CONNINFO is a Connection String as defined in the PostgreSQL manual.\n" 383 | "E.g., \"host=localhost port=5432 dbname=mydb connect_timeout=10\"\n" 384 | "\n" 385 | "Return a user-ptr representing the libpq connection.\n" 386 | "Error if connection cannot established.\n" 387 | "\n\(fn CONNINFO)", 388 | NULL); 389 | 390 | DEFUN("pq:query", Fpq_query, 2, 2+MAX_PQ_PARAMS, 391 | "Execute COMMAND on CONN with optional PARAMETERS.\n" 392 | "\n" 393 | "Run an SQL command on a connection obtained by `pq:connectdb'.\n" 394 | "If PARAMETERS are used, you can reference them in COMMAND using\n" 395 | "$1, $2, ..., $12.\n" 396 | "\n" 397 | "Return the list of rows returned by the last statement in COMMAND.\n" 398 | "Rows are returned as atomic values if the statement yields a single\n" 399 | "column, or a vector of values if it yields more than one column.\n" 400 | "\n" 401 | "SQL values are turned into Lisp strings except for the following:\n" 402 | "\n" 403 | " NULL: always returned as nil\n" 404 | " true/false: t/nil\n" 405 | " integer: integer or float, depending on size\n" 406 | " float, numeric: float\n" 407 | "\n" 408 | "While these conversions are convenient, they may loose precision.\n" 409 | "If you need the full precision of big integer values or need to be\n" 410 | "able to discern between NULL and false, simply cast these to text\n" 411 | "in your query.\n" 412 | "\n" 413 | "Error on SQL errors. Diagnostic information such as warnings is\n" 414 | "emitted using `message'.\n" 415 | "\n\(fn CONN COMMAND &rest PARAMETERS)" 416 | , 417 | NULL); 418 | 419 | DEFUN("pq:escapeLiteral", Fpq_escape, 2, 2, 420 | "Perform literal value quoting on STRING for CONN.\n" 421 | "\n" 422 | "Return a string for use within an SQL command. This is useful\n" 423 | "when inserting data values as literal constants in SQL commands.\n" 424 | "Certain characters (such as quotes and backslashes) must be\n" 425 | "escaped to prevent them from being interpreted specially by the\n" 426 | "SQL parser.\n" 427 | "\n" 428 | "Note that it is not necessary nor correct to do escaping when a\n" 429 | "data value is passed as a separate parameter in `pq:query'.\n" 430 | "\n\(fn CONN STRING)", 431 | PQescapeLiteral); 432 | 433 | DEFUN("pq:escapeIdentifier", Fpq_escape, 2, 2, 434 | "Perform identifier value quoting on STRING for CONN.\n" 435 | "\n" 436 | "Return a string for use as an SQL identifier, such as a table,\n" 437 | "column, or function name. This is useful when a user-supplied\n" 438 | "identifier might contain special characters that would otherwise\n" 439 | "not be interpreted as part of the identifier by the SQL parser,\n" 440 | "or when the identifier might contain upper case characters whose\n" 441 | "case should be preserved.\n" 442 | "\n\(fn CONN STRING)", 443 | PQescapeIdentifier); 444 | 445 | DEFUN("pq:reset", Fpq_reset, 1, 1, 446 | "Resets the communication channel to the server behind CONN.\n" 447 | "\n" 448 | "Return t if connection is ok again.\n" 449 | "\n\(fn CONN)", 450 | NULL); 451 | 452 | DEFUN("pq:notifies", Fpq_notifies, 1, 1, 453 | "Get asynchronous notifications recieved on CONN.\n" 454 | "\n" 455 | "Returns list of vectors [channel-string pid payload-string]\n" 456 | "\n\(fn CONN)", 457 | NULL); 458 | 459 | #undef DEFUN 460 | 461 | /* Define custom error signal. The error data is a list with two 462 | * strings. The first string is the human-readable message, the 463 | * second is the SQLSTATE error code. */ 464 | { 465 | emacs_value Fdefine_error = env->intern (env, "define-error"); 466 | emacs_value Qpq_error = env->intern (env, "pq:error"); 467 | emacs_value errmsg_string = 468 | env->make_string(env, "SQL error", strlen("SQL error")); 469 | emacs_value args[] = {Qpq_error, errmsg_string}; 470 | env->funcall(env, Fdefine_error, 2, args); 471 | } 472 | 473 | provide(env, "pq-core"); 474 | 475 | /* loaded successfully */ 476 | return 0; 477 | } 478 | -------------------------------------------------------------------------------- /pq-test.el: -------------------------------------------------------------------------------- 1 | ;;; pq-test.el --- test libpq bindings -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2020-2022 Free Software Foundation, Inc. 4 | 5 | ;; This program is free software; you can redistribute it and/or modify 6 | ;; it under the terms of the GNU General Public License as published by 7 | ;; the Free Software Foundation, either version 3 of the License, or 8 | ;; (at your option) any later version. 9 | 10 | ;; This program is distributed in the hope that it will be useful, 11 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | ;; GNU General Public License for more details. 14 | 15 | ;; You should have received a copy of the GNU General Public License 16 | ;; along with this program. If not, see . 17 | 18 | ;;; Code: 19 | 20 | (add-to-list 'load-path 21 | (file-name-directory (or #$ (expand-file-name (buffer-file-name))))) 22 | 23 | (require 'pq) 24 | (require 'ert) 25 | 26 | (defvar *conninfo* (or (getenv "PG_CONNINFO") "port=5432 dbname=smith")) 27 | 28 | (ert-deftest pq-query-test () 29 | (let ((conn (pq:connectdb *conninfo*))) 30 | (should (equal (pq:query conn "select 1 union select 2") '(1 2))) 31 | (should (equal (pq:query conn "select 1,2") '([1 2]))) 32 | (should (equal (pq:query conn "select 1,2 union select 3,4") '([1 2] [3 4]))) 33 | (should (equal (pq:query conn "select 'Hello, ' || $1::text" (user-login-name)) 34 | (list (concat "Hello, " (user-login-name))))) 35 | 36 | (should (equal (pq:query conn "select true, false, NULL, 42") 37 | '([t nil nil 42]))) 38 | 39 | ;; Multiple statements 40 | (should (equal (pq:query conn "select 1; select 2; select 3;") '(3))))) 41 | 42 | (ert-deftest pq-encoding-test () 43 | (let ((conn (pq:connectdb *conninfo*))) 44 | (skip-unless (equal '("UTF8") (pq:query conn "show server_encoding"))) 45 | (should (equal (pq:query conn "select length('(╯°□°)╯︵ ┻━┻')") 46 | '(12))) 47 | (should (equal (pq:query conn "select '(╯°□°)╯' ||$1::text" "︵ ┻━┻") 48 | '("(╯°□°)╯︵ ┻━┻"))) 49 | (should-error (pq:query conn "select $1::text" "\x80")) 50 | (should-error (pq:query conn "select text '\x80'")))) 51 | 52 | (ert-deftest pq-escape-test () 53 | (let ((conn (pq:connectdb *conninfo*))) 54 | (should-error (pq:escapeLiteral "d")) 55 | (should-error (pq:escapeIdentifier "d")) 56 | (should-error (pq:escapeLiteral "'" "d")) 57 | (should-error (pq:escapeIdentifier "'" "d")) 58 | (should (equal (pq:escapeLiteral conn "mo'oo\"oo") "'mo''oo\"oo'")) 59 | (should (equal (pq:escapeIdentifier conn "moo'oo\"oo") "\"moo'oo\"\"oo\"")))) 60 | 61 | (ert-deftest pq-garbage-collect-test () 62 | (let ((conn (pq:connectdb *conninfo*))) 63 | (garbage-collect) 64 | (sleep-for 0.2) 65 | (setq conn (pq:connectdb *conninfo*) 66 | conn (pq:connectdb *conninfo*) 67 | conn (pq:connectdb *conninfo*) 68 | conn (pq:connectdb *conninfo*) 69 | conn (pq:connectdb *conninfo*) 70 | conn (pq:connectdb *conninfo*) 71 | conn (pq:connectdb *conninfo*) 72 | conn (pq:connectdb *conninfo*) 73 | conn (pq:connectdb *conninfo*)) 74 | (let ((connection-count 75 | (car 76 | (pq:query 77 | conn 78 | "select count(1) from pg_stat_activity where application_name = 'emacs'")))) 79 | (garbage-collect) 80 | (sleep-for 0.2) 81 | (should 82 | (< 83 | (car 84 | (pq:query 85 | conn 86 | "select count(1) from pg_stat_activity where application_name = 'emacs'")) 87 | (- connection-count 6)))))) 88 | 89 | (ert-deftest pq-signal-error-test () 90 | (should-error (pq:connectdb "invalid-conninfo")) 91 | (let ((conn (pq:connectdb *conninfo*))) 92 | (pq:query conn "select 1") 93 | (should-error (pq:query "select * from")) 94 | (should-error (pq:query conn "select * from")) 95 | (should-error (pq:query conn "select $1::text")) 96 | (should 97 | (equal 98 | 'ok 99 | (condition-case err 100 | (pq:query conn "moo") 101 | (pq:error 102 | (if (string= "42601" (nth 2 err)) 103 | ;; syntax errors are ok 104 | 'ok 105 | (signal (car err) (cdr err))))))) 106 | )) 107 | 108 | (ert-deftest pq-reset-connection-test () 109 | (let ((testconn (pq:connectdb *conninfo*)) 110 | (ctlconn (pq:connectdb *conninfo*))) 111 | (let ((victim (car (pq:query testconn "select pg_backend_pid()")))) 112 | (pq:query ctlconn "select pg_terminate_backend($1)" victim)) 113 | (should-error (pq:query testconn "select 1")) 114 | (pq:reset testconn) 115 | (pq:query testconn "select 1"))) 116 | 117 | (ert-deftest pq-notice-receiver-test () 118 | (let ((conn (pq:connectdb *conninfo*))) 119 | (pq:query conn "set client_min_messages to notice") 120 | (pq:query conn "drop table if exists ert_nonexisting_table") 121 | (with-current-buffer "*Messages*" 122 | (goto-char (point-max)) 123 | (re-search-backward "ert_nonexisting_table")))) 124 | 125 | (ert-deftest pq-async-notify-test () 126 | (let* ((conn (pq:connectdb *conninfo*)) 127 | (mypid (car (pq:query conn "select pg_backend_pid()")))) 128 | (pq:notifies conn) 129 | (pq:query conn "listen ert_notification") 130 | (pq:query conn "notify ert_notification") 131 | (should 132 | (equal 133 | (car (pq:notifies conn)) 134 | (vector "ert_notification" mypid ""))) 135 | (should (equal (pq:notifies conn) nil)) 136 | (pq:query conn "notify ert_notification, 'paylöad'") 137 | (should 138 | (equal 139 | (car (pq:notifies conn)) 140 | (vector "ert_notification" mypid "paylöad"))) 141 | (should-error (pq:notifies 0)) 142 | (should-error (pq:notifies nil)) 143 | (should-error (pq:query conn "select pg_terminate_backend($1)" mypid)) 144 | (should-error (pq:notifies conn)) 145 | )) 146 | 147 | ;;; pq-test.el ends here 148 | -------------------------------------------------------------------------------- /pq.el: -------------------------------------------------------------------------------- 1 | ;;; pq.el --- libpq binding -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2020-2022 Free Software Foundation, Inc. 4 | 5 | ;; Author: Tom Gillespie 6 | ;; URL: https://github.com/anse1/emacs-libpq 7 | ;; Version: 0.02 8 | ;; Package-Requires: ((emacs "25")) 9 | 10 | ;; This program is free software; you can redistribute it and/or modify 11 | ;; it under the terms of the GNU General Public License as published by 12 | ;; the Free Software Foundation, either version 3 of the License, or 13 | ;; (at your option) any later version. 14 | 15 | ;; This program is distributed in the hope that it will be useful, 16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | ;; GNU General Public License for more details. 19 | 20 | ;; You should have received a copy of the GNU General Public License 21 | ;; along with this program. If not, see . 22 | 23 | ;;; Commentary: 24 | 25 | ;; An almost completely empty wrapper to simplify packaging on *elpa. 26 | 27 | ;;; Code: 28 | 29 | (require 'pq-core nil t) ; Don't signal an error if the module is absent. 30 | 31 | ;; Try and compile the `pq-core' module when we compile the PQ package. 32 | (eval-when-compile 33 | (unless (or (featurep 'pq-core) 34 | ;; Try and avoid running this code when we're just 35 | ;; loading the uncompiled `pq.el'. 36 | (and (fboundp 'macroexp-compiling-p) ;Emacs≥28 37 | (not (macroexp-compiling-p)))) 38 | (require 'pq-compile) 39 | (declare-function pq--compile-module "pq-compile" ()) 40 | (ignore-errors (pq--compile-module)))) 41 | 42 | ;; Try and compile the `pq-core' module when the PQ package is loaded. 43 | (unless (featurep 'pq-core) 44 | (require 'pq-compile) 45 | (declare-function pq--compile-maybe "pq-compile" ()) 46 | (pq--compile-maybe)) 47 | 48 | 49 | (provide 'pq) 50 | 51 | ;;; pq.el ends here 52 | --------------------------------------------------------------------------------