├── .github └── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── .gitignore ├── CODE_OF_CONDUCT.md ├── LICENSE ├── Package.swift ├── README.md ├── Sources ├── Curses │ ├── Attribute.swift │ ├── BoxCharacter.swift │ ├── Color.swift │ ├── ColorPair.swift │ ├── Colors.swift │ ├── Curses.swift │ ├── CursesHandlerProtocol.swift │ ├── Cursor.swift │ ├── CursorStyle.swift │ ├── Key.swift │ ├── Keyboard.swift │ ├── Point.swift │ ├── Rect.swift │ ├── Screen.swift │ ├── Size.swift │ └── Window.swift └── ncurses │ ├── module.modulemap │ └── ncurses.h ├── images └── sampleScreen.png └── make.sh /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | ** Environment (please complete the following information):** 27 | - OS: [e.g. Ubuntu 16.04] 28 | - Terminal emulator [e.g. PuTTY] 29 | 30 | **Additional context** 31 | Add any other context about the problem here. 32 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | Package.resolved 3 | .build/ 4 | .trash/ 5 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at support@tangogolfdigital.com. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq 77 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Package.swift: -------------------------------------------------------------------------------- 1 | // swift-tools-version:5.5 2 | // The swift-tools-version declares the minimum version of Swift required to build this package. 3 | 4 | import PackageDescription 5 | 6 | let package = Package( 7 | name: "Curses", 8 | products: [ 9 | .library(name: "Curses", 10 | type: .dynamic, 11 | targets: ["Curses"]), 12 | ], 13 | targets: [ 14 | .target( 15 | name:"Curses", 16 | dependencies: ["ncurses"]), 17 | .systemLibrary(name: "ncurses") 18 | ] 19 | ) 20 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Curses 2 | Curses provides a Swift object wrapper for the curses programming library for Linux (tested on Ubuntu 16.04, 18.04) 3 | 4 | ## What is Curses? 5 | Curses enables better-looking, text-based (console) applications in a terminal-agnostic manner. 6 | This wrapper provides access to some of this functionality via Swift objects. Current functionality suppports: 7 | * Windows 8 | * Cursor manipulation 9 | * Text attribute manipulation 10 | * Color manipulation 11 | * Keyboard access 12 | * Box drawing 13 | 14 | ![Sample Screen](/images/sampleScreen.png?raw=true "Sample Screen") 15 | 16 | ## Usage 17 | 18 | ### Library 19 | In order to use the library, include this resource as a dependency in Package.swift 20 | ```swift 21 | // swift-tools-version:4.0 22 | // The swift-tools-version declares the minimum version of Swift required to build this package. 23 | 24 | import PackageDescription 25 | 26 | let package = Package( 27 | name: "myApplication", 28 | dependencies: [ 29 | .package(url: "https://github.com/TheCoderMerlin/Curses.git", from: "1.0.0"), 30 | ], 31 | targets: [ 32 | .target( 33 | name:"myApplication", 34 | dependencies:["Curses"], 35 | path: "Sources"), 36 | ] 37 | ) 38 | ``` 39 | 40 | ### Opening/Closing the library 41 | To begin using the library, import Curses, access the shared *Screen* object, and invoke *startUp()*. 42 | ```swift 43 | import Curses 44 | 45 | let screen = Screen.shared 46 | screen.startUp() 47 | ``` 48 | 49 | When done with the library, be sure to cleanly exit by invoking *shutDown()*. 50 | ```swift 51 | screen.shutDown() 52 | ``` 53 | 54 | ### Interrupt Handler 55 | A common paradigm is to continue running the application until interrupted with ^C. An easy way to acheive this is as follows: 56 | ```swift 57 | // Define an interrupt handler 58 | let screen = Screen.shared 59 | 60 | class Handler : CursesHandlerProtocol { 61 | func interruptHandler() { 62 | screen.shutDown() 63 | print("Good bye!") 64 | exit(0) 65 | } 66 | 67 | func windowChangedHandler() { 68 | } 69 | } 70 | 71 | // Start up 72 | screen.startUp(handler:Handler()) 73 | 74 | // Do some fun stuff 75 | 76 | // Wait forever, or until the user presses ^C 77 | screen.wait() 78 | ``` 79 | ### Windows 80 | Provide shortcut access to the single instance of the screen's window 81 | It's OK to use this instance OR to create separate windows located on the screen 82 | but it's generally not a good practice to mix and match. 83 | 84 | To use only the main window: 85 | ```swift 86 | let mainWindow = screen.window 87 | ``` 88 | 89 | To use only separate windows: 90 | ```swift 91 | let firstWindow = screen.newWindow(position:Point(x:10, y:20), size:Size(width:100, height:20)) 92 | let secondWindow = screen.newWindow(position:Point(x:120, y:10), size:Size(width:100, height:20)) 93 | ``` 94 | 95 | ### Writing to the Console 96 | Writing will occur at the current cursor position using the currently active attributes 97 | ```swift 98 | mainWindow.write("Hello, world!") 99 | ``` 100 | 101 | ### Flushing changes to the Console 102 | **IMPORTANT:** Changes will not be visible on the console until a *refresh()* is invoked 103 | ```swift 104 | mainWindow.refresh() 105 | ``` 106 | ### Enabling Scrolling 107 | mainWindow.setScroll(enabled:true) 108 | 109 | ### Moving the Cursor 110 | ```swift 111 | // Move the cursor to an absolute position 112 | let cursor = mainWindow.cursor 113 | cursor.position = Point(x:10, y:10) 114 | 115 | // Temporarily move the cursor to a new position 116 | cursor.pushPosition(newPosition:Point(x:0, y:0)) 117 | mainWindow.write("Cursor is at: \(cursor.position)") 118 | cursor.popPosition() 119 | ``` 120 | ### Using Attributes 121 | Attributes may be turned on by having the window *turnOn()* the attribute. 122 | It's polite to *turnOff()* the attribute when done. 123 | To set a particular attribute without regard to the current attributes at that 124 | location, execute *setTo()*. 125 | 126 | ```swift 127 | // Display text in various attributes 128 | mainWindow.turnOn(Attribute.normal) 129 | mainWindow.write("Normal") 130 | mainWindow.turnOff(Attribute.normal) 131 | mainWindow.write(" ") 132 | 133 | mainWindow.turnOn(Attribute.standout) 134 | mainWindow.write("Standout") 135 | mainWindow.turnOff(Attribute.standout) 136 | mainWindow.write(" ") 137 | 138 | mainWindow.turnOn(Attribute.underline) 139 | mainWindow.write("Underline") 140 | mainWindow.turnOff(Attribute.underline) 141 | mainWindow.write(" ") 142 | 143 | mainWindow.turnOn(Attribute.reverse) 144 | mainWindow.write("Reverse") 145 | mainWindow.turnOff(Attribute.reverse) 146 | mainWindow.write(" ") 147 | 148 | mainWindow.turnOn(Attribute.blink) 149 | mainWindow.write("Blink") 150 | mainWindow.turnOff(Attribute.blink) 151 | mainWindow.write(" ") 152 | 153 | mainWindow.turnOn(Attribute.dim) 154 | mainWindow.write("Dim") 155 | mainWindow.turnOff(Attribute.dim) 156 | mainWindow.write(" ") 157 | 158 | mainWindow.turnOn(Attribute.bold) 159 | mainWindow.write("Bold") 160 | mainWindow.turnOff(Attribute.bold) 161 | ``` 162 | 163 | ### Using Color 164 | Before using color, Colors needs to be started up. 165 | It's important to ensure that the terminal supports colors before proceeding. 166 | Colors may only be started up AFTER Curses is started up. 167 | ```swift 168 | screen.startUp(handler:handler) 169 | 170 | let colors = Colors.shared 171 | precondition(colors.areSupported, "This terminal doesn't support colors") 172 | colors.startUp() 173 | ``` 174 | Standard colors can be accessed by using an enum: 175 | ```swift 176 | public enum StandardColor : String, CaseIterable { 177 | case black 178 | case red 179 | case green 180 | case yellow 181 | case blue 182 | case magenta 183 | case cyan 184 | case white 185 | } 186 | ``` 187 | Colors are always used in pairs, one for the foreground and one for the background. 188 | To write to the screen using red as the foreground and white as the background, 189 | we create a pair, turn it on, and then politely turn it off when done. 190 | ```swift 191 | let red = Color.standard(.red) 192 | let white = Color.standard(.white) 193 | let redOnWhite = colors.newPair(foreground:red, background:white) 194 | 195 | mainWindow.cursor.position = Point(x:0, y:0) 196 | mainWindow.turnOn(redOnWhite) 197 | mainWindow.write("RED ON WHITE") 198 | mainWindow.turnOff(redOnWhite) 199 | ``` 200 | We can create a chart of color pairs and display them: 201 | ```swift 202 | // Find the length of the longest color name 203 | // We'll use this for spacing the columns 204 | let maxColorNameLength = Color.StandardColor.allCases.map {$0.rawValue.count}.max()! 205 | let xSpaceBetweenNames = 3 206 | // We'll start the display at the third row 207 | var row = 3 208 | // Iterate through all of the foreground and background colors 209 | for foregroundColor in Color.StandardColor.allCases { 210 | var column = 1 211 | for backgroundColor in Color.StandardColor.allCases { 212 | // Create a new color pair 213 | // Note that the number of color pairs is limited so this may not work on all terminals 214 | precondition(colors.pairCount + 1 < colors.maxPairCount, "Unable to create more color pairs.") 215 | let pair = colors.newPair(foreground:Color.standard(foregroundColor), background:Color.standard(backgroundColor)) 216 | 217 | // Turn on the color attribute 218 | // It's polite to turn off what we turned on (below) 219 | mainWindow.turnOn(pair) 220 | // Position the cursor 221 | mainWindow.cursor.position = Point(x: column * (maxColorNameLength + xSpaceBetweenNames), y:row) 222 | // Write the color name 223 | mainWindow.write(backgroundColor.rawValue) 224 | // Turn off the color attribute 225 | mainWindow.turnOff(pair) 226 | column += 1 227 | } 228 | row += 1 229 | } 230 | ``` 231 | Custom colors can be created by specifying red, green, and blue values 232 | in the range of 0 through 1000, provided the terminal supports this functionality. 233 | If supported, there are a limited number of "slots" available . 234 | ```swift 235 | precondition(colors.customColorsAreSupported, "Custom colors are not supported.") 236 | precondition(colors.colorCount + 1 < colors.maxColorCount, "No more slots available for custom colors.") 237 | let orange = colors.newColor(red:1000, green:500, blue:0) 238 | precondition(colors.pairCount + 1 < colors.maxPairCount, "Unable to create more color pairs.") 239 | let orangeOnBlack = colors.newPair(foreground:orange, background:Color.standard(.black)) 240 | 241 | mainWindow.turnOn(orangeOnBlack) 242 | mainWindow.write("Orange") 243 | mainWindow.turnOff(orangeOnBlack) 244 | ``` 245 | 246 | ### Changing the Background 247 | ```swift 248 | let cyan = Color.standard(.cyan) 249 | let black = Color.standard(.black) 250 | let cyanOnBlack = colors.newPair(foreground:black, background:cyan) 251 | 252 | mainWindow.backgroundSet(attribute:cyanOnBlack) 253 | mainWindow.clear() 254 | mainWindow.write("Hello, World!") 255 | mainWindow.refresh() 256 | ``` 257 | 258 | ### Using the keyboard 259 | 260 | ```swift 261 | let keyboard = Keyboard.shared 262 | 263 | while true { 264 | let key = keyboard.getKey(window:mainWindow) 265 | 266 | var youPressed : String 267 | if key.keyType == .isCharacter { 268 | youPressed = "You pressed: \(key.character!)" 269 | } else if key.keyType == .isControl { 270 | youPressed = "You pressed: CONTROL-\(key.control!)" 271 | } else { 272 | var label : String 273 | switch (key.keyType) { 274 | case .arrowDown: label = "Down" 275 | case .arrowUp: label = "Up" 276 | case .arrowRight: label = "Right" 277 | case .arrowLeft: label = "Left" 278 | 279 | case .function1: label = "F1" 280 | case .function2: label = "F2" 281 | case .function3: label = "F3" 282 | case .function4: label = "F4" 283 | 284 | case .enter: label = "ENTER" 285 | 286 | default: label = "Other" 287 | } 288 | youPressed = "You pressed a special key: \(label)" 289 | } 290 | mainWindow.cursor.position = Point(x:1, y:2) 291 | mainWindow.write(youPressed) 292 | mainWindow.clearToEndOfLine() 293 | mainWindow.refresh() 294 | } 295 | ``` 296 | 297 | ### Getting text from a field 298 | ```swift 299 | let cyan = Color.standard(.cyan) 300 | let black = Color.standard(.black) 301 | let cyanOnBlack = colors.newPair(foreground:black, background:cyan) 302 | let string = mainWindow.getStringFromTextField(at:Point(x:10, y:10), maxCharacters:10, fieldColorPair:cyanOnBlack) 303 | ``` 304 | -------------------------------------------------------------------------------- /Sources/Curses/Attribute.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | /** 20 | The `Attribute` class provides the ability to alter the text attribute 21 | of the text in a `Window`. 22 | 23 | Instances of this class may not be initialized by client code. 24 | Rather, there are several preset constants available. 25 | The class is also used internally to represent colors. 26 | 27 | Typical usage: 28 | 29 | ``` 30 | window.turnOn(Attribute.underline) 31 | window.write("This text is underlined.") 32 | window.turnOff(Attribute.underline) 33 | ``` 34 | */ 35 | public class Attribute { 36 | // value is a raw value of attribute 37 | internal let value : Int 38 | 39 | internal init(value:Int) { 40 | self.value = value 41 | } 42 | 43 | // Normal terminal display (no highlighting) 44 | static public let normal = Attribute(value:Curses.attributeNormal) 45 | 46 | // Terminal display with highlighting 47 | static public let standout = Attribute(value:Curses.attributeStandout) 48 | 49 | // Text is underlined 50 | static public let underline = Attribute(value:Curses.attributeUnderline) 51 | 52 | // Text is reversed 53 | static public let reverse = Attribute(value:Curses.attributeReverse) 54 | 55 | // Text blinks 56 | static public let blink = Attribute(value:Curses.attributeBlink) 57 | 58 | // Text is dimmed 59 | static public let dim = Attribute(value:Curses.attributeDim) 60 | 61 | // Text is bold 62 | static public let bold = Attribute(value:Curses.attributeBold) 63 | 64 | // Text is invisible 65 | static public let invisible = Attribute(value:Curses.attributeInvisible) 66 | } 67 | -------------------------------------------------------------------------------- /Sources/Curses/BoxCharacter.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | public class BoxCharacter { 20 | // DO NOT CHANGE THE ORDER OF THESE CASES 21 | // We rely on the ordering to look up the correct values 22 | public enum Spokes : UInt8 { 23 | case none 24 | case right 25 | case bottom 26 | case bottomRight 27 | 28 | case left 29 | case leftRight 30 | case leftBottom 31 | case leftBottomRight 32 | 33 | case top 34 | case topRight 35 | case topBottom 36 | case topBottomRight 37 | 38 | case topLeft 39 | case topLeftRight 40 | case topLeftBottom 41 | case all 42 | } // enum 43 | 44 | public enum SingleSpoke { 45 | case top 46 | case left 47 | case bottom 48 | case right 49 | } 50 | public typealias SingleSpokes = Set 51 | 52 | public static let thickNone : Character = " " 53 | public static let thickRight : Character = "\u{257A}" // ╺ 54 | public static let thickBottom : Character = "\u{257B}" // ╻ 55 | public static let thickBottomRight : Character = "\u{250F}" // ┏ 56 | 57 | public static let thickLeft : Character = "\u{2578}" // ╸ 58 | public static let thickLeftRight : Character = "\u{2501}" // ━ 59 | public static let thickLeftBottom : Character = "\u{2513}" // ┓ 60 | public static let thickLeftBottomRight : Character = "\u{2533}" // ┳ 61 | 62 | public static let thickTop : Character = "\u{2579}" // ╹ 63 | public static let thickTopRight : Character = "\u{2517}" // ┗ 64 | public static let thickTopBottom : Character = "\u{2503}" // ┃ 65 | public static let thickTopBottomRight : Character = "\u{2523}" // ┣ 66 | 67 | public static let thickTopLeft : Character = "\u{251B}" // ┛ 68 | public static let thickTopLeftRight : Character = "\u{253B}" // ┻ 69 | public static let thickTopLeftBottom : Character = "\u{252B}" // ┫ 70 | public static let thickAll : Character = "\u{254B}" // ╋ 71 | 72 | // DO NOT CHANGE THE ORDER OF THESE ELEMENTS 73 | // We rely on the ordering to look up the correct values 74 | private static let thick = [thickNone, thickRight, thickBottom, thickBottomRight, 75 | thickLeft, thickLeftRight, thickLeftBottom, thickLeftBottomRight, 76 | thickTop, thickTopRight, thickTopBottom, thickTopBottomRight, 77 | thickTopLeft, thickTopLeftRight, thickTopLeftBottom, thickAll] 78 | 79 | 80 | public private(set) var spokes : Spokes 81 | public var thickCharacter : Character { 82 | return BoxCharacter.thick[Int(spokes.rawValue)] 83 | } 84 | 85 | 86 | private static func indexFromIndividualSpokes(top:Bool, left:Bool, bottom:Bool, right:Bool) -> UInt8 { 87 | // Calculate the raw value 88 | var rawValue : UInt8 = 0 89 | rawValue += top ? 1 : 0 90 | rawValue *= 2 91 | 92 | rawValue += left ? 1 : 0 93 | rawValue *= 2 94 | 95 | rawValue += bottom ? 1 : 0 96 | rawValue *= 2 97 | 98 | rawValue += right ? 1 : 0 99 | return rawValue 100 | } 101 | 102 | public init(top:Bool, left:Bool, bottom:Bool, right:Bool) { 103 | let index = BoxCharacter.indexFromIndividualSpokes(top:top, left:left, bottom:bottom, right:right) 104 | precondition(index < BoxCharacter.thick.count, "Specified index (\(index)) was invalid because it exceeds count of thick array.") 105 | guard let spokes = Spokes(rawValue: index) else { 106 | fatalError("Specified index (\(index)) was invalid because Spokes could not be found") 107 | } 108 | self.spokes = spokes 109 | } 110 | 111 | public convenience init(withSpokes singleSpokes:SingleSpokes) { 112 | let top = singleSpokes.contains(.top) 113 | let left = singleSpokes.contains(.left) 114 | let bottom = singleSpokes.contains(.bottom) 115 | let right = singleSpokes.contains(.right) 116 | self.init(top:top, left:left, bottom:bottom, right:right) 117 | } 118 | } 119 | -------------------------------------------------------------------------------- /Sources/Curses/Color.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | public class Color { 20 | internal let index : Int 21 | public internal(set) var red : Int // Value in thousandths 22 | public internal(set) var green : Int // Value in thousandths 23 | public internal(set) var blue : Int // Value in thousandths 24 | 25 | // Creates a new color 26 | internal init(index:Int, red:Int, green:Int, blue:Int) { 27 | self.index = index 28 | self.red = red 29 | self.green = green 30 | self.blue = blue 31 | } 32 | 33 | // Retrieves an existing color by index 34 | internal init(index:Int) { 35 | self.index = index 36 | (self.red, self.green, self.blue) = Curses.shared.getColor(index:index) 37 | } 38 | 39 | // Standard colors 40 | public enum StandardColor : String, CaseIterable { 41 | case black 42 | case red 43 | case green 44 | case yellow 45 | case blue 46 | case magenta 47 | case cyan 48 | case white 49 | } 50 | 51 | static public func standard(_ standardName:StandardColor) -> Color { 52 | switch (standardName) { 53 | case .black: return Color.black 54 | case .red: return Color.red 55 | case .green: return Color.green 56 | case .yellow: return Color.yellow 57 | case .blue: return Color.blue 58 | case .magenta: return Color.magenta 59 | case .cyan: return Color.cyan 60 | case .white: return Color.white 61 | } 62 | } 63 | 64 | static public let black : Color = { 65 | return Color(index:0) 66 | }() 67 | 68 | static public let red : Color = { 69 | return Color(index:1) 70 | }() 71 | 72 | static public let green : Color = { 73 | return Color(index:2) 74 | }() 75 | 76 | static public let yellow : Color = { 77 | return Color(index:3) 78 | }() 79 | 80 | static public let blue : Color = { 81 | return Color(index:4) 82 | }() 83 | 84 | static public let magenta : Color = { 85 | return Color(index:5) 86 | }() 87 | 88 | static public let cyan : Color = { 89 | return Color(index:6) 90 | }() 91 | 92 | static public let white : Color = { 93 | return Color(index:7) 94 | }() 95 | 96 | 97 | } 98 | -------------------------------------------------------------------------------- /Sources/Curses/ColorPair.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | public class ColorPair : Attribute { 20 | internal let index : Int 21 | public let foreground : Color 22 | public let background : Color 23 | 24 | // Creates a new, named pair 25 | internal init(index:Int, foreground:Color, background:Color) { 26 | self.index = index 27 | self.foreground = foreground 28 | self.background = background 29 | 30 | super.init(value:Curses.shared.colorAttributeValue(pairIndex:index)) 31 | } 32 | 33 | internal init(index:Int) { 34 | self.index = index 35 | 36 | let (foregroundIndex, backgroundIndex) = Curses.shared.getColorPair(index:index) 37 | self.foreground = Color(index:foregroundIndex) 38 | self.background = Color(index:backgroundIndex) 39 | 40 | super.init(value:Curses.shared.colorAttributeValue(pairIndex:index)) 41 | } 42 | 43 | static public let defaultPair : ColorPair = { 44 | return ColorPair(index:0) 45 | }() 46 | 47 | } 48 | -------------------------------------------------------------------------------- /Sources/Curses/Colors.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | public class Colors { 20 | 21 | public static let shared = Colors() 22 | private let curses = Curses.shared 23 | 24 | // Explicitly disable clients from creating objects of this class 25 | private init() { 26 | } 27 | 28 | private var started : Bool = false 29 | public private(set) var colorCount = 8 // There are eight default colors at start 30 | public private(set) var pairCount = 1 // There is one default pair at start 31 | 32 | // ============================== API ============================== 33 | public func startUp() { 34 | startIfNecessary() 35 | } 36 | 37 | public var maxColorCount : Int { 38 | return curses.maxColorCount 39 | } 40 | 41 | public var maxPairCount : Int { 42 | return curses.maxColorPairCount 43 | } 44 | 45 | public var areSupported : Bool { 46 | return curses.colorsAreSupported 47 | } 48 | 49 | public var customColorsAreSupported : Bool { 50 | return curses.customColorsAreSupported 51 | } 52 | 53 | public func newColor(red:Int, green:Int, blue:Int) -> Color { 54 | precondition((0...1000).contains(red), "Red must be in range of 0...1000, not \(red)") 55 | precondition((0...1000).contains(green), "Green must be in range of 0...1000, not \(green)") 56 | precondition((0...1000).contains(blue), "Blue must be in range of 0...1000, not \(blue)") 57 | precondition(colorCount < maxColorCount, "Unable to add more colors, already at maximum \(maxColorCount)") 58 | precondition(customColorsAreSupported, "Terminal does not support adding colors") 59 | 60 | startIfNecessary() 61 | 62 | let newColorIndex = colorCount 63 | colorCount += 1 64 | curses.setColor(index:newColorIndex, red:red, green:green, blue:blue) 65 | return Color(index:newColorIndex, red:red, green:green, blue:blue) 66 | } 67 | 68 | public func newPair(foreground:Color, background:Color) -> ColorPair { 69 | precondition(pairCount < maxPairCount, "Unable to add more pairs; already at maximum \(maxPairCount)") 70 | 71 | startIfNecessary() 72 | 73 | let newPairIndex = pairCount 74 | pairCount += 1 75 | curses.setColorPair(index:newPairIndex, foregroundIndex:foreground.index, backgroundIndex:background.index) 76 | return ColorPair(index:newPairIndex, foreground:foreground, background:background) 77 | } 78 | 79 | // ============================== Helper Functions ============================== 80 | func startIfNecessary() { 81 | if !started { 82 | // Start using colors 83 | curses.startColors() 84 | 85 | // Remember that we've started 86 | started = true 87 | } 88 | } 89 | 90 | 91 | } 92 | -------------------------------------------------------------------------------- /Sources/Curses/Curses.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | import Foundation 20 | import ncurses 21 | 22 | 23 | // References: 24 | // http://tldp.org/HOWTO/NCURSES-Programming-HOWTO/init.html 25 | // http://www.cs.ukzn.ac.za/~hughm/os/notes/ncurses.html 26 | // https://invisible-island.net/ncurses/ncurses-intro.html 27 | 28 | // This is a singleton class 29 | internal class Curses { 30 | // ============================== Singleton Pattern ============================== 31 | static let shared = Curses() 32 | 33 | 34 | // ============================== Type ============================== 35 | enum KeyboardBufferingMode { 36 | case bufferingIsOn 37 | case bufferingIsOff 38 | case halfDelay(tenthsOfSecond:Int) 39 | } 40 | 41 | 42 | 43 | // ============================== Variables ============================== 44 | 45 | static var handler : CursesHandlerProtocol? = nil 46 | 47 | var startUpCount = 0 48 | 49 | // Explicitly disable clients from creating objects of this class 50 | private init() { 51 | // Register signal handlers 52 | Curses.registerSignalHandlers() 53 | } 54 | 55 | 56 | // ============================== Internal API ============================== 57 | 58 | func startUp(handler:CursesHandlerProtocol? = nil) { 59 | precondition(startUpCount == 0, "Curses is already running.") 60 | 61 | // Store user's handler 62 | Curses.handler = handler 63 | 64 | 65 | // Set locale 66 | setlocale(LC_ALL, "") 67 | 68 | // Initialize curses 69 | ncurses.initscr() 70 | ncurses.noecho() 71 | 72 | startUpCount += 1 73 | } 74 | 75 | func shutDown() { 76 | precondition(startUpCount == 1, "No instance of Curses is currently running.") 77 | 78 | Curses.handler = nil 79 | ncurses.endwin() 80 | 81 | startUpCount -= 1 82 | } 83 | 84 | func wait() { 85 | while true { 86 | select(0, nil, nil, nil, nil) 87 | } 88 | } 89 | 90 | func cursorPosition(windowHandle:UnsafeMutablePointer) -> Point { 91 | return getCursorPosition(windowHandle:windowHandle) 92 | } 93 | 94 | func screenSize(windowHandle:UnsafeMutablePointer) -> Size { 95 | return getScreenSize(windowHandle:windowHandle) 96 | } 97 | 98 | func setCursorStyle(_ cursorStyle:CursorStyle) { 99 | ncurses.curs_set(cursorStyle.rawValue) 100 | } 101 | 102 | func setKeyPadMode(windowHandle:UnsafeMutablePointer) { 103 | ncurses.keypad(windowHandle, true) // Processes special keys into special codes rather than escape sequences 104 | } 105 | 106 | func setKeyboardBufferingMode(_ keyboardBufferingMode:KeyboardBufferingMode) { 107 | switch (keyboardBufferingMode) { 108 | case .bufferingIsOn : 109 | ncurses.nocbreak() 110 | case .bufferingIsOff: 111 | ncurses.cbreak() 112 | case .halfDelay(let tenthsOfSecond): 113 | ncurses.halfdelay(Int32(tenthsOfSecond)) 114 | } 115 | } 116 | 117 | func setScroll(windowHandle:UnsafeMutablePointer, enabled:Bool) { 118 | ncurses.scrollok(windowHandle, enabled) 119 | } 120 | 121 | func getKey(windowHandle:UnsafeMutablePointer) -> Key { 122 | let code = ncurses.wgetch(windowHandle) 123 | let key = Key(code:code) 124 | return key 125 | } 126 | 127 | func newWindow(position:Point, size:Size) -> UnsafeMutablePointer { 128 | return ncurses.newwin(Int32(size.height), Int32(size.width), Int32(position.y), Int32(position.x)) 129 | } 130 | 131 | func moveWindow(windowHandle:UnsafeMutablePointer, to:Point) { 132 | ncurses.mvwin(windowHandle, Int32(to.y), Int32(to.x)) 133 | } 134 | 135 | func getWindowPosition(windowHandle:UnsafeMutablePointer) -> Point { 136 | let xPosition = getbegx(windowHandle) 137 | let yPosition = getbegy(windowHandle) 138 | return Point(x:Int(xPosition), y:Int(yPosition)) 139 | } 140 | 141 | func resizeWindow(windowHandle:UnsafeMutablePointer, size:Size) { 142 | ncurses.wresize(windowHandle, Int32(size.height), Int32(size.width)) 143 | } 144 | 145 | func refresh(windowHandle:UnsafeMutablePointer) { 146 | ncurses.wrefresh(windowHandle) 147 | } 148 | 149 | func clear(windowHandle:UnsafeMutablePointer) { 150 | ncurses.wclear(windowHandle) 151 | } 152 | 153 | func clearToEndOfLine(windowHandle:UnsafeMutablePointer) { 154 | ncurses.wclrtoeol(windowHandle) 155 | } 156 | 157 | func clearToBottomOfWindow(windowHandle:UnsafeMutablePointer) { 158 | ncurses.wclrtobot(windowHandle) 159 | } 160 | 161 | func move(windowHandle:UnsafeMutablePointer, to:Point) { 162 | ncurses.wmove(windowHandle, Int32(to.y), Int32(to.x)) 163 | } 164 | 165 | func write(windowHandle:UnsafeMutablePointer, string:String) { 166 | ncurses.waddstr(windowHandle, string) 167 | } 168 | 169 | func attributeOn(windowHandle:UnsafeMutablePointer, attributeValue:Int) { 170 | ncurses.wattron(windowHandle, Int32(attributeValue)) 171 | } 172 | 173 | func attributeOff(windowHandle:UnsafeMutablePointer, attributeValue:Int) { 174 | ncurses.wattroff(windowHandle, Int32(attributeValue)) 175 | } 176 | 177 | func attributeSet(windowHandle:UnsafeMutablePointer, attributeValue:Int) { 178 | ncurses.wattrset(windowHandle, Int32(attributeValue)) 179 | } 180 | 181 | func backgroundSet(windowHandle:UnsafeMutablePointer, attributeValue:Int, character:Character) { 182 | let unicodeScalars = character.unicodeScalars 183 | let ascii = UInt32(unicodeScalars[unicodeScalars.startIndex].value) 184 | let attributeAndCharacter : UInt32 = UInt32(attributeValue) | ascii 185 | ncurses.wbkgdset(windowHandle, attributeAndCharacter) 186 | } 187 | 188 | var maxColorCount : Int { 189 | return Int(COLORS) 190 | } 191 | 192 | var maxColorPairCount : Int { 193 | return Int(COLOR_PAIRS) 194 | } 195 | 196 | var colorsAreSupported : Bool { 197 | return has_colors() 198 | } 199 | 200 | var customColorsAreSupported : Bool { 201 | return can_change_color() 202 | } 203 | 204 | func startColors() { 205 | if !colorsAreSupported { 206 | fatalError("Unable to start colors because they are not supported on this terminal.") 207 | } 208 | start_color() 209 | } 210 | 211 | func getColor(index:Int) -> (red:Int, green:Int, blue:Int) { 212 | var red : Int16 = 0 213 | var green : Int16 = 0 214 | var blue : Int16 = 0 215 | getColorContent(index:Int16(index), red:&red, green:&green, blue:&blue) 216 | return (red:Int(red), green:Int(green), blue:Int(blue)) 217 | } 218 | 219 | func setColor(index:Int, red:Int, green:Int, blue:Int) { 220 | init_color(Int16(index), Int16(red), Int16(green), Int16(blue)) 221 | } 222 | 223 | func getColorPair(index:Int) -> (foregroundIndex:Int, backgroundIndex:Int) { 224 | var foregroundIndex : Int16 = 0 225 | var backgroundIndex : Int16 = 0 226 | getColorPair(index:Int16(index), foregroundIndex:&foregroundIndex, backgroundIndex:&backgroundIndex) 227 | return (foregroundIndex:Int(foregroundIndex), backgroundIndex:Int(backgroundIndex)) 228 | } 229 | 230 | func setColorPair(index:Int, foregroundIndex:Int, backgroundIndex:Int) { 231 | init_pair(Int16(index), Int16(foregroundIndex), Int16(backgroundIndex)) 232 | } 233 | 234 | 235 | func colorAttributeValue(pairIndex:Int) -> Int { 236 | return Int(COLOR_PAIR(Int32(pairIndex))) 237 | } 238 | 239 | static let attributeNormal : Int = { 240 | return 0 241 | }() 242 | 243 | static let attributeStandout : Int = { 244 | return Int(ncursesBits(mask:1, shift:8)) 245 | }() 246 | 247 | static let attributeUnderline : Int = { 248 | return Int(ncursesBits(mask:1, shift:9)) 249 | }() 250 | 251 | static let attributeReverse : Int = { 252 | return Int(ncursesBits(mask:1, shift:10)) 253 | }() 254 | 255 | static let attributeBlink : Int = { 256 | return Int(ncursesBits(mask:1, shift:11)) 257 | }() 258 | 259 | static let attributeDim : Int = { 260 | return Int(ncursesBits(mask:1, shift:12)) 261 | }() 262 | 263 | static let attributeBold : Int = { 264 | return Int(ncursesBits(mask:1, shift:13)) 265 | }() 266 | 267 | static let attributeInvisible : Int = { 268 | return Int(ncursesBits(mask:1, shift:15)) 269 | }() 270 | 271 | 272 | 273 | // ============================== Helper Functions ============================== 274 | // NB: This appears to only update after an endwin/refresh/initscr 275 | private func getScreenSize(windowHandle:UnsafeMutablePointer) -> Size { 276 | let width : Int32 = getmaxx(windowHandle) 277 | let height : Int32 = getmaxy(windowHandle) 278 | return Size(width:Int(width), height:Int(height)) 279 | } 280 | 281 | private func getCursorPosition(windowHandle:UnsafeMutablePointer) -> Point { 282 | let x : Int32 = getcurx(windowHandle) 283 | let y : Int32 = getcury(windowHandle) 284 | return Point(x:Int(x), y:Int(y)) 285 | } 286 | 287 | private func getColorContent(index:Int16, red:inout Int16, green:inout Int16, blue:inout Int16) { 288 | color_content(index, &red, &green, &blue) 289 | } 290 | 291 | private func getColorPair(index:Int16, foregroundIndex:inout Int16, backgroundIndex:inout Int16) { 292 | pair_content(index, &foregroundIndex, &backgroundIndex) 293 | } 294 | 295 | 296 | /* These attributes are not imported into swift and are duplicated here 297 | #define NCURSES_ATTR_SHIFT 8 298 | #define NCURSES_BITS(mask,shift) (NCURSES_CAST(chtype,(mask)) << ((shift) + NCURSES_ATTR_SHIFT)) 299 | 300 | #define A_NORMAL (1UL - 1UL) 301 | #define A_ATTRIBUTES NCURSES_BITS(~(1UL - 1UL),0) 302 | #define A_CHARTEXT (NCURSES_BITS(1UL,0) - 1UL) 303 | #define A_COLOR NCURSES_BITS(((1UL) << 8) - 1UL,0) 304 | #define A_STANDOUT NCURSES_BITS(1UL,8) 305 | #define A_UNDERLINE NCURSES_BITS(1UL,9) 306 | #define A_REVERSE NCURSES_BITS(1UL,10) 307 | #define A_BLINK NCURSES_BITS(1UL,11) 308 | #define A_DIM NCURSES_BITS(1UL,12) 309 | #define A_BOLD NCURSES_BITS(1UL,13) 310 | #define A_ALTCHARSET NCURSES_BITS(1UL,14) 311 | #define A_INVIS NCURSES_BITS(1UL,15) 312 | #define A_PROTECT NCURSES_BITS(1UL,16) 313 | #define A_HORIZONTAL NCURSES_BITS(1UL,17) 314 | #define A_LEFT NCURSES_BITS(1UL,18) 315 | #define A_LOW NCURSES_BITS(1UL,19) 316 | #define A_RIGHT NCURSES_BITS(1UL,20) 317 | #define A_TOP NCURSES_BITS(1UL,21) 318 | #define A_VERTICAL NCURSES_BITS(1UL,22) 319 | 320 | #if 1 321 | #define A_ITALIC NCURSES_BITS(1UL,23) /* ncurses extension */ 322 | #endif 323 | */ 324 | 325 | private static func ncursesBits(mask:UInt32, shift:UInt32) -> UInt32 { 326 | return mask << (shift + 8) 327 | } 328 | 329 | 330 | // ============================== Signal Handler Definitions ============================== 331 | private enum Signal : Int32 { 332 | case int = 2 333 | case winch = 28 334 | } 335 | 336 | private typealias SignalHandler = __sighandler_t 337 | 338 | private static func trap(signalNumber:Signal, action:@escaping SignalHandler) { 339 | signal(signalNumber.rawValue, action) 340 | } 341 | 342 | private static func registerSignalHandlers() { 343 | // Register signal handlers 344 | trap(signalNumber:.int) {signal in 345 | Curses.interruptHandler(signal) 346 | } 347 | 348 | trap(signalNumber:.winch) {signal in 349 | Curses.winchHandler(signal) 350 | } 351 | } 352 | 353 | // ============================== Signal Handlers ============================== 354 | private static func interruptHandler(_ signal:Int32) { 355 | if let handler = handler { 356 | handler.interruptHandler() 357 | } 358 | } 359 | 360 | private static func winchHandler(_ signal:Int32) { 361 | if let handler = handler { 362 | handler.windowChangedHandler() 363 | } 364 | } 365 | 366 | 367 | 368 | } 369 | -------------------------------------------------------------------------------- /Sources/Curses/CursesHandlerProtocol.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | public protocol CursesHandlerProtocol { 20 | 21 | // This handler is invoked whenever an interrupt occurs 22 | func interruptHandler() 23 | 24 | 25 | // This handler is invoked whenever the window changes size 26 | func windowChangedHandler() 27 | } 28 | -------------------------------------------------------------------------------- /Sources/Curses/Cursor.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | public class Cursor { 20 | 21 | private let curses = Curses.shared 22 | private unowned let window:Window 23 | private var positionStack = [Point]() 24 | 25 | internal init(window:Window) { 26 | self.window = window 27 | } 28 | 29 | // ============================== API ============================== 30 | public var position : Point { 31 | get { 32 | return curses.cursorPosition(windowHandle:window.windowHandle) 33 | } 34 | set(newPosition) { 35 | curses.move(windowHandle:window.windowHandle, to:newPosition) 36 | } 37 | } 38 | 39 | public func set(style : CursorStyle) { 40 | curses.setCursorStyle(style) 41 | } 42 | 43 | public func pushPosition() { 44 | positionStack.append(position) 45 | } 46 | 47 | public func pushPosition(newPosition:Point) { 48 | positionStack.append(position) 49 | position = newPosition 50 | } 51 | 52 | public func popPosition() { 53 | guard let oldPosition = positionStack.popLast() else { 54 | fatalError("Cursor position stack is empty; unable to popPosition()") 55 | } 56 | position = oldPosition 57 | } 58 | 59 | } 60 | -------------------------------------------------------------------------------- /Sources/Curses/CursorStyle.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | public enum CursorStyle : Int32 { 20 | case invisible = 0 21 | case normal = 1 22 | case veryVisible = 2 23 | } 24 | 25 | -------------------------------------------------------------------------------- /Sources/Curses/Key.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | import ncurses 20 | 21 | public struct Key { 22 | private static let down = KEY_DOWN /* down-arrow key */ 23 | private static let up = KEY_UP /* up-arrow key */ 24 | private static let left = KEY_LEFT /* left-arrow key */ 25 | private static let right = KEY_RIGHT /* right-arrow key */ 26 | 27 | private static let backspace = KEY_BACKSPACE /* backspace key */ 28 | 29 | private static let F1 = KEY_F0 + 1 /* Function keys */ 30 | private static let F2 = KEY_F0 + 2 31 | private static let F3 = KEY_F0 + 3 32 | private static let F4 = KEY_F0 + 4 33 | private static let F5 = KEY_F0 + 5 34 | private static let F6 = KEY_F0 + 6 35 | private static let F7 = KEY_F0 + 7 36 | private static let F8 = KEY_F0 + 8 37 | private static let F9 = KEY_F0 + 9 38 | private static let F10 = KEY_F0 + 10 39 | private static let F11 = KEY_F0 + 11 40 | private static let F12 = KEY_F0 + 12 41 | 42 | private static let enter = KEY_ENTER 43 | 44 | private static let keyError = ERR 45 | 46 | public enum KeyType { 47 | // key type 48 | case isUnknown 49 | case isControl 50 | case isCharacter 51 | 52 | // special keys 53 | case arrowDown 54 | case arrowUp 55 | case arrowLeft 56 | case arrowRight 57 | 58 | case backspace 59 | 60 | case function1 61 | case function2 62 | case function3 63 | case function4 64 | case function5 65 | case function6 66 | case function7 67 | case function8 68 | case function9 69 | case function10 70 | case function11 71 | case function12 72 | 73 | case enter 74 | 75 | case keyError 76 | } 77 | 78 | let specialKeyMap = [ 79 | down : KeyType.arrowDown, 80 | up : KeyType.arrowUp, 81 | left : KeyType.arrowLeft, 82 | right : KeyType.arrowRight, 83 | 84 | backspace : KeyType.backspace, 85 | 86 | F1 : KeyType.function1, 87 | F2 : KeyType.function2, 88 | F3 : KeyType.function3, 89 | F4 : KeyType.function4, 90 | F5 : KeyType.function5, 91 | F6 : KeyType.function6, 92 | F7 : KeyType.function7, 93 | F8 : KeyType.function8, 94 | F9 : KeyType.function9, 95 | F10 : KeyType.function10, 96 | F11 : KeyType.function11, 97 | F12 : KeyType.function12, 98 | 99 | enter : KeyType.enter, 100 | 101 | keyError : KeyType.keyError 102 | ] 103 | 104 | // Code and key type are always set 105 | private let code : Int32 106 | public let keyType : KeyType 107 | 108 | // Character and control key are set as appropriate 109 | public let character : Character? 110 | public let control : UInt8? 111 | 112 | init(code:Int32) { 113 | self.code = code 114 | 115 | let specialKey = specialKeyMap[code] 116 | if specialKey != nil { 117 | // We found a special key so we set the key type accordingingly 118 | keyType = specialKey! 119 | character = nil 120 | control = nil 121 | } else if (0...31).contains(code) { 122 | // We found a control key 123 | keyType = .isControl 124 | character = nil 125 | control = UInt8(code) 126 | } else if (32...127).contains(code) { 127 | // We found an ascii key 128 | keyType = .isCharacter 129 | guard let unicodeScalar = UnicodeScalar(Int(code)) else { 130 | fatalError("Expected unicode scalar for code: \(code)") 131 | } 132 | 133 | character = Character(unicodeScalar) 134 | control = nil 135 | } else { 136 | // Unknown 137 | keyType = .isUnknown 138 | character = nil 139 | control = nil 140 | } 141 | } 142 | 143 | 144 | 145 | 146 | /* 147 | let KEY_HOME = 0o0406 /* home key */ 148 | 149 | 150 | let KEY_DL = 0o0510 /* delete-line key */ 151 | let KEY_IL = 0o0511 /* insert-line key */ 152 | let KEY_DC = 0o0512 /* delete-character key */ 153 | let KEY_IC = 0o0513 /* insert-character key */ 154 | let KEY_EIC = 0o0514 /* sent by rmir or smir in insert mode */ 155 | let KEY_CLEAR = 0o0515 /* clear-screen or erase key */ 156 | let KEY_EOS = 0o0516 /* clear-to-end-of-screen key */ 157 | let KEY_EOL = 0o0517 /* clear-to-end-of-line key */ 158 | let KEY_SF = 0o0520 /* scroll-forward key */ 159 | let KEY_SR = 0o0521 /* scroll-backward key */ 160 | let KEY_NPAGE = 0o0522 /* next-page key */ 161 | let KEY_PPAGE = 0o0523 /* previous-page key */ 162 | let KEY_STAB = 0o0524 /* set-tab key */ 163 | let KEY_CTAB = 0o0525 /* clear-tab key */ 164 | let KEY_CATAB = 0o0526 /* clear-all-tabs key */ 165 | let KEY_PRINT = 0o0532 /* print key */ 166 | let KEY_LL = 0o0533 /* lower-left key (home down) */ 167 | let KEY_A1 = 0o0534 /* upper left of keypad */ 168 | let KEY_A3 = 0o0535 /* upper right of keypad */ 169 | let KEY_B2 = 0o0536 /* center of keypad */ 170 | let KEY_C1 = 0o0537 /* lower left of keypad */ 171 | let KEY_C3 = 0o0540 /* lower right of keypad */ 172 | let KEY_BTAB = 0o0541 /* back-tab key */ 173 | let KEY_BEG = 0o0542 /* begin key */ 174 | let KEY_CANCEL = 0o0543 /* cancel key */ 175 | let KEY_CLOSE = 0o0544 /* close key */ 176 | let KEY_COMMAND = 0o0545 /* command key */ 177 | let KEY_COPY = 0o0546 /* copy key */ 178 | let KEY_CREATE = 0o0547 /* create key */ 179 | let KEY_END = 0o0550 /* end key */ 180 | let KEY_EXIT = 0o0551 /* exit key */ 181 | let KEY_FIND = 0o0552 /* find key */ 182 | let KEY_HELP = 0o0553 /* help key */ 183 | let KEY_MARK = 0o0554 /* mark key */ 184 | let KEY_MESSAGE = 0o0555 /* message key */ 185 | let KEY_MOVE = 0o0556 /* move key */ 186 | let KEY_NEXT = 0o0557 /* next key */ 187 | let KEY_OPEN = 0o0560 /* open key */ 188 | let KEY_OPTIONS = 0o0561 /* options key */ 189 | let KEY_PREVIOUS = 0o0562 /* previous key */ 190 | let KEY_REDO = 0o0563 /* redo key */ 191 | let KEY_REFERENCE = 0o0564 /* reference key */ 192 | let KEY_REFRESH = 0o0565 /* refresh key */ 193 | let KEY_REPLACE = 0o0566 /* replace key */ 194 | let KEY_RESTART = 0o0567 /* restart key */ 195 | let KEY_RESUME = 0o0570 /* resume key */ 196 | let KEY_SAVE = 0o0571 /* save key */ 197 | let KEY_SBEG = 0o0572 /* shifted begin key */ 198 | let KEY_SCANCEL = 0o0573 /* shifted cancel key */ 199 | let KEY_SCOMMAND = 0o0574 /* shifted command key */ 200 | let KEY_SCOPY = 0o0575 /* shifted copy key */ 201 | let KEY_SCREATE = 0o0576 /* shifted create key */ 202 | let KEY_SDC = 0o0577 /* shifted delete-character key */ 203 | let KEY_SDL = 0o0600 /* shifted delete-line key */ 204 | let KEY_SELECT = 0o0601 /* select key */ 205 | let KEY_SEND = 0o0602 /* shifted end key */ 206 | let KEY_SEOL = 0o0603 /* shifted clear-to-end-of-line key */ 207 | let KEY_SEXIT = 0o0604 /* shifted exit key */ 208 | let KEY_SFIND = 0o0605 /* shifted find key */ 209 | let KEY_SHELP = 0o0606 /* shifted help key */ 210 | let KEY_SHOME = 0o0607 /* shifted home key */ 211 | let KEY_SIC = 0o0610 /* shifted insert-character key */ 212 | let KEY_SLEFT = 0o0611 /* shifted left-arrow key */ 213 | let KEY_SMESSAGE = 0o0612 /* shifted message key */ 214 | let KEY_SMOVE = 0o0613 /* shifted move key */ 215 | let KEY_SNEXT = 0o0614 /* shifted next key */ 216 | let KEY_SOPTIONS = 0o0615 /* shifted options key */ 217 | let KEY_SPREVIOUS = 0o0616 /* shifted previous key */ 218 | let KEY_SPRINT = 0o0617 /* shifted print key */ 219 | let KEY_SREDO = 0o0620 /* shifted redo key */ 220 | let KEY_SREPLACE = 0o0621 /* shifted replace key */ 221 | let KEY_SRIGHT = 0o0622 /* shifted right-arrow key */ 222 | let KEY_SRSUME = 0o0623 /* shifted resume key */ 223 | let KEY_SSAVE = 0o0624 /* shifted save key */ 224 | let KEY_SSUSPEND = 0o0625 /* shifted suspend key */ 225 | let KEY_SUNDO = 0o0626 /* shifted undo key */ 226 | let KEY_SUSPEND = 0o0627 /* suspend key */ 227 | let KEY_UNDO = 0o0630 /* undo key */ 228 | let KEY_MOUSE = 0o0631 /* Mouse event has occurred */ 229 | let KEY_RESIZE = 0o0632 /* Terminal resize event */ 230 | let KEY_EVENT = 0o0633 /* We were interrupted by an event */ 231 | */ 232 | 233 | 234 | } 235 | 236 | -------------------------------------------------------------------------------- /Sources/Curses/Keyboard.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | public class Keyboard { 20 | 21 | public static let shared = Keyboard() 22 | private let curses = Curses.shared 23 | 24 | // Explicitly disable clients from creating object of this class 25 | private init() { 26 | } 27 | 28 | // ============================== API ============================== 29 | public func getKey(window:Window) -> Key { 30 | return curses.getKey(windowHandle:window.windowHandle) 31 | } 32 | 33 | public func setBufferingOn() { 34 | curses.setKeyboardBufferingMode(.bufferingIsOn) 35 | } 36 | 37 | public func setBufferingOff() { 38 | curses.setKeyboardBufferingMode(.bufferingIsOff) 39 | } 40 | 41 | public func setBufferingDelayed(tenthsOfSecond:Int) { 42 | curses.setKeyboardBufferingMode(.halfDelay(tenthsOfSecond:tenthsOfSecond)) 43 | } 44 | 45 | } 46 | -------------------------------------------------------------------------------- /Sources/Curses/Point.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | public struct Point { 20 | public let x : Int 21 | public let y : Int 22 | 23 | public init(x:Int, y:Int) { 24 | self.x = x 25 | self.y = y 26 | } 27 | 28 | public func offsetBy(xOffset:Int, yOffset:Int) -> Point { 29 | return Point(x: x+xOffset, y:y+yOffset) 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /Sources/Curses/Rect.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | public struct Rect { 20 | public let topLeft : Point 21 | public let size : Size 22 | public var bottomRight : Point { 23 | return Point(x:topLeft.x + size.width - 1, 24 | y:topLeft.y + size.height - 1) 25 | } 26 | 27 | public init(topLeft:Point, size:Size) { 28 | self.topLeft = topLeft 29 | self.size = size 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /Sources/Curses/Screen.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | public class Screen { 20 | 21 | 22 | private let curses = Curses.shared 23 | 24 | public static let shared = Screen() 25 | private var standardWindow : Window? = nil 26 | 27 | // Explictly disable clients from creating objects of this class 28 | private init() { 29 | } 30 | 31 | // ============================== API ============================== 32 | public var window : Window { 33 | precondition(standardWindow != nil, "Screen.window is not available until after startUp") 34 | return standardWindow! 35 | } 36 | 37 | public func startUp(handler:CursesHandlerProtocol? = nil) { 38 | curses.startUp(handler:handler) 39 | standardWindow = Window() 40 | } 41 | 42 | public func shutDown() { 43 | curses.shutDown() 44 | standardWindow = nil 45 | } 46 | 47 | public func newWindow(position:Point, size:Size) -> Window { 48 | return Window(position:position, size:size) 49 | } 50 | 51 | public func wait() { 52 | curses.wait() 53 | } 54 | 55 | } 56 | -------------------------------------------------------------------------------- /Sources/Curses/Size.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | public struct Size { 20 | public let width : Int 21 | public let height : Int 22 | 23 | public init(width:Int, height:Int) { 24 | self.width = width 25 | self.height = height 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /Sources/Curses/Window.swift: -------------------------------------------------------------------------------- 1 | /* 2 | Curses - ncurses object library for Swift 3 | Copyright (C) 2018 CoderMerlin.com 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 | 19 | import ncurses 20 | 21 | public class Window { 22 | private let curses = Curses.shared 23 | 24 | let windowHandle : UnsafeMutablePointer 25 | private var _cursor : Cursor! = nil 26 | 27 | public var cursor : Cursor { 28 | return _cursor 29 | } 30 | 31 | // Creates the default window covering the entire screen 32 | internal init() { 33 | windowHandle = stdscr 34 | _cursor = Cursor(window:self) 35 | curses.setKeyPadMode(windowHandle:windowHandle) 36 | } 37 | 38 | internal init(position:Point, size:Size) { 39 | self.windowHandle = curses.newWindow(position:position, size:size) 40 | self._cursor = Cursor(window:self) 41 | curses.setKeyPadMode(windowHandle:windowHandle) 42 | } 43 | 44 | public func setScroll(enabled:Bool) { 45 | curses.setScroll(windowHandle:windowHandle, enabled:enabled) 46 | } 47 | 48 | public func refresh() { 49 | curses.refresh(windowHandle:windowHandle) 50 | } 51 | 52 | public func backgroundSet(attribute:Attribute, character:Character = " ") { 53 | let attributeValue = attribute.value 54 | curses.backgroundSet(windowHandle:windowHandle, attributeValue:attributeValue, character:character) 55 | } 56 | 57 | public func clear() { 58 | curses.clear(windowHandle:windowHandle) 59 | } 60 | 61 | public func clearToEndOfLine() { 62 | curses.clearToEndOfLine(windowHandle:windowHandle) 63 | } 64 | 65 | public func clearToBottomOfWindow() { 66 | curses.clearToBottomOfWindow(windowHandle:windowHandle) 67 | } 68 | 69 | public var size : Size { 70 | get { 71 | return curses.screenSize(windowHandle:windowHandle) 72 | } 73 | 74 | set (newSize) { 75 | curses.resizeWindow(windowHandle:windowHandle, size:newSize) 76 | } 77 | } 78 | 79 | public var position : Point { 80 | get { 81 | return curses.getWindowPosition(windowHandle:windowHandle) 82 | } 83 | 84 | set (newPosition) { 85 | curses.moveWindow(windowHandle:windowHandle, to:newPosition) 86 | } 87 | } 88 | 89 | public func write(_ string:String) { 90 | curses.write(windowHandle:windowHandle, string:string) 91 | } 92 | 93 | public func write(_ character:Character) { 94 | write(String(character)) 95 | } 96 | 97 | public func turnOn(_ attribute:Attribute) { 98 | let attributeValue = attribute.value 99 | curses.attributeOn(windowHandle:windowHandle, attributeValue:attributeValue) 100 | } 101 | 102 | public func turnOff(_ attribute:Attribute) { 103 | let attributeValue = attribute.value 104 | curses.attributeOff(windowHandle:windowHandle, attributeValue:attributeValue) 105 | } 106 | 107 | public func setTo(_ attribute:Attribute) { 108 | let attributeValue = attribute.value 109 | curses.attributeSet(windowHandle:windowHandle, attributeValue:attributeValue) 110 | } 111 | 112 | public func draw(_ rect:Rect) { 113 | precondition(rect.size.width >= 2, "Unable to draw a Rect that is less than width of 2.") 114 | precondition(rect.size.height >= 2, "Unable to draw a Rect that is less than height of 2.") 115 | 116 | // Determine corners 117 | let topLeftCorner = BoxCharacter(top:false, left:false, bottom:true, right:true).thickCharacter 118 | let topRightCorner = BoxCharacter(top:false, left:true, bottom:true, right:false).thickCharacter 119 | let bottomLeftCorner = BoxCharacter(top:true, left:false, bottom:false, right:true).thickCharacter 120 | let bottomRightCorner = BoxCharacter(top:true, left:true, bottom:false, right:false).thickCharacter 121 | 122 | // Determine horizontal 123 | let horizontal = BoxCharacter(top:false, left:true, bottom:false, right:true).thickCharacter 124 | let vertical = BoxCharacter(top:true, left:false, bottom:true, right:false).thickCharacter 125 | 126 | // Determine top line 127 | var topLine = String(topLeftCorner) 128 | topLine += String(repeating:horizontal, count:rect.size.width - 2) 129 | topLine += String(topRightCorner) 130 | 131 | // Determine bottom line 132 | var bottomLine = String(bottomLeftCorner) 133 | bottomLine += String(repeating:horizontal, count:rect.size.width - 2) 134 | bottomLine += String(bottomRightCorner) 135 | 136 | // We'll restore the cursor to its starting position when we're done 137 | cursor.pushPosition(newPosition:rect.topLeft) 138 | let left = rect.topLeft.x 139 | let right = left + rect.size.width - 1 140 | let top = rect.topLeft.y 141 | let bottom = top + rect.size.height - 1 142 | 143 | // Write the top line 144 | write(topLine) 145 | 146 | // Write the body 147 | for offsetY in 1 ..< rect.size.height - 1 { 148 | cursor.position = Point(x:left, y:top + offsetY) 149 | write(String(vertical)) 150 | 151 | cursor.position = Point(x:right, y:top + offsetY) 152 | write(String(vertical)) 153 | } 154 | 155 | // Write the bottom line 156 | cursor.position = Point(x:left, y:bottom) 157 | write(bottomLine) 158 | 159 | // Restore the cursor 160 | cursor.popPosition() 161 | } 162 | 163 | // Returns a string as entered by the user, providing for simple editing support using left and right arrows and the backspace 164 | // key. The input is collected from a field beginning at the specified position of a maximum length as specified. 165 | // If a fieldColorPair is specified Colors MUST be active. The field will then be displayed in the specified colorPair. 166 | // The function will exit when either TAB or ENTER is pressed 167 | public func getStringFromTextField(at fieldPosition:Point, maxCharacters:Int, fieldColorPair:ColorPair?) -> String { 168 | // Access keyboard 169 | let keyboard = Keyboard.shared 170 | 171 | // Save cursor position to be restored later and move cursor to field 172 | cursor.pushPosition() 173 | cursor.position = fieldPosition 174 | 175 | // If a fieldColorPair is specified, we turn that color on 176 | if let fieldColorPair = fieldColorPair { 177 | turnOn(fieldColorPair) 178 | let pad = String(repeating:" ", count:maxCharacters) 179 | write(pad) 180 | cursor.position = fieldPosition 181 | } 182 | 183 | var string = "" 184 | var insertionPoint = string.startIndex 185 | var shouldExit = false 186 | repeat { 187 | let key = keyboard.getKey(window:self) 188 | switch key.keyType { 189 | case .isCharacter: 190 | // Only allow insertion if we're below the maxCharacters permitted 191 | if (string.count < maxCharacters) { 192 | // Update the string 193 | string.insert(key.character!, at:insertionPoint) 194 | 195 | // Move the insertion point forward 196 | insertionPoint = string.index(after:insertionPoint) 197 | 198 | // Write the chracter and move the cursor forward 199 | write(key.character!) 200 | 201 | // Print the remaining characters 202 | if insertionPoint < string.endIndex { 203 | let remainingCharacters = String(string[insertionPoint...]) 204 | 205 | // Write the remaining characters 206 | write(remainingCharacters) 207 | 208 | // Move the cursor back 209 | cursor.position = cursor.position.offsetBy(xOffset:-remainingCharacters.count, yOffset:0) 210 | } 211 | } 212 | case .backspace: 213 | if insertionPoint > string.startIndex { 214 | // Move the insertion point backward 215 | insertionPoint = string.index(before:insertionPoint) 216 | 217 | // Update the string 218 | string.remove(at:insertionPoint) 219 | 220 | // Move the cursor backward 221 | cursor.position = cursor.position.offsetBy(xOffset:-1, yOffset:0) 222 | 223 | // Write the string from this point forward in order 224 | // to erase what was there previously 225 | // The final character printed will be a space to erase 226 | // the last character 227 | let remainingCharacters = String(string[insertionPoint...]) 228 | write(remainingCharacters) 229 | write(" ") 230 | 231 | // Move the cursor back again 232 | cursor.position = cursor.position.offsetBy(xOffset:-remainingCharacters.count-1, yOffset:0) 233 | } 234 | case .arrowLeft: 235 | if insertionPoint > string.startIndex { 236 | // Move the insertion point backward 237 | insertionPoint = string.index(before:insertionPoint) 238 | 239 | // Move the cursor backward 240 | cursor.position = cursor.position.offsetBy(xOffset:-1, yOffset:0) 241 | } 242 | case .arrowRight: 243 | if insertionPoint < string.endIndex { 244 | // Move the insertion point forward 245 | insertionPoint = string.index(after:insertionPoint) 246 | 247 | // Move the cursor forward 248 | cursor.position = cursor.position.offsetBy(xOffset:1, yOffset:0) 249 | } 250 | case .isControl: 251 | let isEnter = key.control! == 10 252 | let isTab = key.control! == 9 253 | shouldExit = isEnter || isTab 254 | default: 255 | do {} 256 | } 257 | } while !shouldExit 258 | 259 | 260 | // If a fieldColorPair is specified, we turn that color off 261 | if let fieldColorPair = fieldColorPair { 262 | turnOff(fieldColorPair) 263 | } 264 | 265 | // Restore cursor position and return string 266 | cursor.popPosition() 267 | return string 268 | } 269 | 270 | } 271 | -------------------------------------------------------------------------------- /Sources/ncurses/module.modulemap: -------------------------------------------------------------------------------- 1 | module ncurses [system] { 2 | header "ncurses.h" 3 | link "ncursesw" 4 | export * 5 | } -------------------------------------------------------------------------------- /Sources/ncurses/ncurses.h: -------------------------------------------------------------------------------- 1 | #include 2 | -------------------------------------------------------------------------------- /images/sampleScreen.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TheCoderMerlin/Curses/1290eb90a3fbb9ae9478ce44aaccf2c50ed20926/images/sampleScreen.png -------------------------------------------------------------------------------- /make.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | makeSwift "$@" 3 | --------------------------------------------------------------------------------