├── .github └── workflows │ └── build.yml ├── .gitignore ├── LICENSE ├── README.md ├── build.zig └── src ├── commands ├── cd.zig ├── exit.zig ├── help.zig └── history.zig ├── interpreter └── interpreter.zig ├── main.zig ├── shell.zig └── utils ├── config.zig ├── execute.zig ├── file.zig ├── history.zig └── marker.zig /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Compile Project 2 | 3 | on: 4 | push: 5 | branches: [master, main] 6 | pull_request: 7 | branches: [master, main] 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | 13 | steps: 14 | - name: Checkout Repository 15 | uses: actions/checkout@v3 16 | 17 | - name: Setup Zig 18 | uses: mlugg/setup-zig@v1 19 | 20 | - name: Build Project 21 | run: zig build -Doptimize=ReleaseFast 22 | 23 | - name: Upload Artifact 24 | uses: actions/upload-artifact@v4 25 | with: 26 | name: zi 27 | path: zig-out/bin/zi 28 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .zig-cache 2 | zig-out -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![zi-banner-smol](https://github.com/user-attachments/assets/12cfa71b-721b-4a7e-84c7-159b8220b97a) 2 | 3 | banner made by [@Sophed](https://github.com/Sophed) 4 | 5 | # About: 6 | 7 | **zi** is a non-POSIX shell written in zig 8 | 9 | **Docs can be found**: [Here](https://github.com/ZI-Project/zi/wiki) 10 | 11 | ## Support: 12 | 13 | **:x:: no support** 14 | 15 | **⚠️: community support** 16 | 17 | **✔: full support** 18 | 19 | | Operating System | Supported | 20 | | ------------- | ------------- | 21 | | Windows | :x: | 22 | | Mac | ⚠️ | 23 | | FreeBSD | ✔ | 24 | | Linux | ✔ | 25 | 26 | ## Features: 27 | * Interpreter to run .zi files 28 | * Easy to configure 29 | * Shell changers which are special commands that change properties about the shell 30 | * Basic shell commands like: ``cd``, ``help``, ``exit`` 31 | 32 | # Compiling from source: 33 | 34 | ## Requirements: 35 | * zig 36 | 37 | Arch Linux: 38 | ``sudo pacman -S zig`` 39 | 40 | Mac OS: 41 | ``brew install zig`` 42 | 43 | Fedora: 44 | ``dnf install zig`` 45 | 46 | Gentoo: 47 | ``emerge -av dev-lang/zig`` 48 | 49 | ## Step 1. 50 | Clone this repo: 51 | ```bash 52 | git clone https://github.com/CoolPuppyKid/zi.git 53 | ``` 54 | ## Step 2. 55 | ```bash 56 | cd zi 57 | zig build -Doptimize=ReleaseFast 58 | ./zig-out/bin/zi 59 | ``` 60 | -------------------------------------------------------------------------------- /build.zig: -------------------------------------------------------------------------------- 1 | const std = @import("std"); 2 | 3 | // this is gonna be the most basic build file you have ever seen 4 | pub fn build(b: *std.Build) void { 5 | const target = b.standardTargetOptions(.{}); 6 | const optimize = b.standardOptimizeOption(.{}); 7 | const exe = b.addExecutable(.{ .name = "zi", .root_source_file = b.path("src/main.zig"), .target = target, .optimize = optimize }); 8 | 9 | b.installArtifact(exe); 10 | 11 | // run step 12 | const run_cmd = b.addRunArtifact(exe); 13 | run_cmd.step.dependOn(b.getInstallStep()); 14 | if (b.args) |args| { 15 | run_cmd.addArgs(args); 16 | } 17 | const run_step = b.step("run", "run the compiled shell"); 18 | run_step.dependOn(&run_cmd.step); 19 | } 20 | -------------------------------------------------------------------------------- /src/commands/cd.zig: -------------------------------------------------------------------------------- 1 | // purpose: implements the cd command 2 | const std = @import("std"); 3 | const marker = @import("../utils/marker.zig"); 4 | 5 | var defaultPWD: []const u8 = "/"; 6 | 7 | pub fn cd(input: []u8, allocater: std.mem.Allocator, printMarker: bool, map: *std.StringHashMap([]u8), psMarker: *std.ArrayList(u8)) !void { 8 | var args = std.mem.split(u8, input, " "); 9 | while (args.next()) |arg| { 10 | if (std.mem.eql(u8, arg, "cd")) { 11 | continue; 12 | } else if (std.mem.eql(u8, arg, "..")) { 13 | const cwd = try std.fs.cwd().realpathAlloc(allocater, "."); 14 | defer allocater.free(cwd); 15 | 16 | const parent = getParentDir(cwd); 17 | 18 | var parent_dir = try std.fs.cwd().openDir(parent, .{}); 19 | 20 | defer parent_dir.close(); 21 | 22 | try parent_dir.setAsCwd(); 23 | } else if (std.mem.eql(u8, arg, "~")) { 24 | const homeDir = defaultPWD; 25 | var dir = try std.fs.cwd().openDir(homeDir, .{}); 26 | 27 | defer dir.close(); 28 | 29 | try dir.setAsCwd(); 30 | } else if (std.mem.count(u8, arg, "$") > 0) { 31 | var envVar: ?[]const u8 = null; 32 | const indexOfVarMarker: ?usize = std.mem.indexOf(u8, arg, "$"); 33 | if (indexOfVarMarker == null) { 34 | return error.CannotIndex; 35 | } 36 | const envVarKey = arg[indexOfVarMarker.? + 1 ..]; 37 | if (std.process.getEnvVarOwned(allocater, envVarKey)) |val| { 38 | envVar = val; 39 | } else |err| { 40 | if (err == std.process.GetEnvVarOwnedError.EnvironmentVariableNotFound) { 41 | envVar = map.get(envVarKey) orelse null; 42 | } 43 | } 44 | 45 | if (envVar == null) { 46 | return error.VarNotFound; 47 | } 48 | var dir = try std.fs.cwd().openDir(envVar.?, .{}); 49 | 50 | defer dir.close(); 51 | 52 | try dir.setAsCwd(); 53 | } else { 54 | var dir = try std.fs.cwd().openDir(arg, .{}); 55 | 56 | defer dir.close(); 57 | 58 | try dir.setAsCwd(); 59 | } 60 | } 61 | if (printMarker) { 62 | try marker.printShellMarker(allocater, psMarker); 63 | } 64 | } 65 | 66 | fn getParentDir(dir: []const u8) []const u8 { 67 | const last_delimiter = std.mem.lastIndexOf(u8, dir, "/"); 68 | if (last_delimiter == 0) { 69 | return "/"; 70 | } 71 | return dir[0..last_delimiter.?]; 72 | } 73 | 74 | pub fn setDefaultPWD(pwd: []const u8) !void { 75 | defaultPWD = pwd; 76 | var dir = try std.fs.cwd().openDir(defaultPWD, .{}); 77 | 78 | defer dir.close(); 79 | } 80 | -------------------------------------------------------------------------------- /src/commands/exit.zig: -------------------------------------------------------------------------------- 1 | // purpose: implements the exit command 2 | const std = @import("std"); 3 | 4 | pub fn exit() !void { 5 | std.process.exit(0); 6 | } 7 | -------------------------------------------------------------------------------- /src/commands/help.zig: -------------------------------------------------------------------------------- 1 | // purpose: implement the help command very helpful 2 | const std = @import("std"); 3 | const marker = @import("../utils/marker.zig"); 4 | const ArrayList = std.ArrayList; 5 | 6 | pub fn help(allocater: std.mem.Allocator, psMarker: *std.ArrayList(u8)) !void { 7 | const stdout = std.io.getStdOut().writer(); 8 | try stdout.print("Help:\n", .{}); 9 | 10 | var list = ArrayList([]const u8).init(allocater); 11 | defer list.deinit(); 12 | 13 | var dir = try std.fs.cwd().openDir("/bin", .{ .iterate = true }); 14 | defer dir.close(); 15 | 16 | var walker = try dir.walk(allocater); 17 | defer walker.deinit(); 18 | 19 | while (try walker.next()) |file| { 20 | try stdout.print("{s}\n", .{file.basename}); 21 | } 22 | 23 | try marker.printShellMarker(allocater, psMarker); 24 | } 25 | -------------------------------------------------------------------------------- /src/commands/history.zig: -------------------------------------------------------------------------------- 1 | const std = @import("std"); 2 | const historyUtil = @import("../utils/history.zig"); 3 | const file = @import("../utils/file.zig"); 4 | 5 | pub fn history(input: []u8, allocater: std.mem.Allocator) !void { 6 | const homeDir = try std.process.getEnvVarOwned(allocater, "HOME"); 7 | const cacheDir = try std.fs.path.join(allocater, &[_][]const u8{ homeDir, ".cache" }); 8 | const ziCacheDir = try std.fs.path.join(allocater, &[_][]const u8{ cacheDir, "zi" }); 9 | const historyFile = try std.fs.path.join(allocater, &[_][]const u8{ ziCacheDir, "history.txt" }); 10 | defer { 11 | allocater.free(homeDir); 12 | allocater.free(cacheDir); 13 | allocater.free(ziCacheDir); 14 | allocater.free(historyFile); 15 | } 16 | 17 | const stdout = std.io.getStdOut().writer(); 18 | var args = std.mem.split(u8, input, " "); 19 | var dontPrint: bool = false; 20 | while (args.next()) |arg| { 21 | if (std.mem.eql(u8, arg, "history")) { 22 | continue; 23 | } else if (std.mem.eql(u8, arg, "-c")) { 24 | try historyUtil.clearHistory(allocater); 25 | dontPrint = true; 26 | } 27 | } 28 | if (!dontPrint) { 29 | const fullHistory: []const u8 = try file.fileReadAll(historyFile, allocater); 30 | defer allocater.free(fullHistory); 31 | try stdout.print("{s}", .{fullHistory}); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/interpreter/interpreter.zig: -------------------------------------------------------------------------------- 1 | // purpose: provide critical functions for running .zi files 2 | const std = @import("std"); 3 | const ArrayList = std.ArrayList; 4 | const cd = @import("../commands/cd.zig"); 5 | const exit = @import("../commands/exit.zig"); 6 | const execute = @import("../utils/execute.zig"); 7 | const marker = @import("../utils/marker.zig"); 8 | const file = @import("../utils/file.zig"); 9 | 10 | // @constCast is everywhere lol 11 | 12 | // the u8 is not a char it is return code 13 | pub fn runZiFile(path: []const u8, allocater: std.mem.Allocator, envVarMap: *std.StringHashMap([]u8), shortens: *std.StringHashMap([]u8), psMarker: *std.ArrayList(u8)) !u8 { 14 | const stdout = std.io.getStdOut().writer(); 15 | 16 | if (!try file.fileExists(path)) { 17 | try stdout.print("zi interpreter error:\n\nfile does not exist\n", .{}); 18 | return 1; 19 | } 20 | const ziFile = try file.fileReadAll(path, allocater); 21 | defer allocater.free(ziFile); 22 | 23 | var ziFileLines = std.mem.split(u8, ziFile, "\n"); 24 | 25 | while (ziFileLines.next()) |line| { 26 | if (std.mem.startsWith(u8, line, "exit")) { 27 | try exit.exit(); 28 | } else if (std.mem.startsWith(u8, line, "cd")) { 29 | cd.cd(@constCast(line), allocater, false, envVarMap, psMarker) catch |err| { 30 | try stdout.print("zi interpreter error:\n\ncd returned: {}\n\n", .{err}); 31 | }; 32 | } else if (std.mem.startsWith(u8, line, "@defaultPWD")) { 33 | var tokenList = try tokenize(line, allocater); 34 | 35 | defer tokenList.deinit(); 36 | 37 | if (tokenList.items.len == 1 or !std.mem.eql(u8, tokenList.items[1], "=")) { 38 | try stdout.print("zi interpreter error:\n\nexpected: = after: {s}\n\n", .{tokenList.items[0]}); 39 | return 1; 40 | } 41 | 42 | if (tokenList.items.len == 3 and std.mem.count(u8, tokenList.items[2], "$") > 0) { 43 | const indexOfVarMarker: ?usize = std.mem.indexOf(u8, tokenList.items[2], "$"); 44 | if (indexOfVarMarker == null) { 45 | try stdout.print("zi interpreter error:\n\n im as clueless as you please make a github issue and attach the zi file\n\n", .{}); 46 | return 1; 47 | } 48 | const envVarKey = tokenList.items[2][indexOfVarMarker.? + 1 ..]; 49 | const envVar = try std.process.getEnvVarOwned(allocater, envVarKey); 50 | try cd.setDefaultPWD(envVar); 51 | } else if (tokenList.items.len == 3) { 52 | try cd.setDefaultPWD(tokenList.items[2]); 53 | } else { 54 | try stdout.print("zi interpreter error:\n\nexpected: (value) after: {s}\n\n", .{tokenList.items[1]}); 55 | return 1; 56 | } 57 | } else if (std.mem.startsWith(u8, line, "@set")) { 58 | var tokenList = try tokenize(line, allocater); 59 | 60 | defer tokenList.deinit(); 61 | 62 | const indexOfMarker: ?usize = std.mem.indexOf(u8, tokenList.items[0], "@set"); 63 | if (indexOfMarker == null) { 64 | try stdout.print("zi interpreter error:\n\n unknown error please make a github issue with the .zi file attached\n\n", .{}); 65 | return 1; 66 | } 67 | 68 | if (tokenList.items.len == 1 or !std.mem.eql(u8, tokenList.items[1], "=")) { 69 | try stdout.print("zi interpreter error:\n\nexpected: = after: {s}\n\n", .{tokenList.items[0]}); 70 | return 1; 71 | } 72 | 73 | if (tokenList.items.len < 3) { 74 | try stdout.print("zi interpreter error:\n\nexpected: (value) after: =\n\n", .{}); 75 | return 1; 76 | } 77 | 78 | const newVarKey: []const u8 = tokenList.items[0][indexOfMarker.? + 4 ..]; 79 | 80 | var newShortenVal = ArrayList(u8).init(allocater); 81 | defer newShortenVal.deinit(); 82 | 83 | for (tokenList.items[2..]) |item| { 84 | if (!std.mem.eql(u8, tokenList.items[2], item)) { 85 | try newShortenVal.appendSlice(" "); 86 | } 87 | try newShortenVal.appendSlice(item); 88 | } 89 | 90 | // btw this gets deallocated later 91 | const clonedVarVal = try allocater.alloc(u8, newShortenVal.items.len); 92 | const clonedVarKey = try allocater.alloc(u8, newVarKey.len); 93 | std.mem.copyForwards(u8, clonedVarVal, @constCast(newShortenVal.items)); 94 | std.mem.copyForwards(u8, clonedVarKey, @constCast(newVarKey)); 95 | 96 | try envVarMap.put(clonedVarKey, clonedVarVal); 97 | } else if (std.mem.startsWith(u8, line, "@PS1")) { 98 | var tokenList = try tokenize(line, allocater); 99 | 100 | defer tokenList.deinit(); 101 | 102 | const indexOfMarker: ?usize = std.mem.indexOf(u8, tokenList.items[0], "@PS1"); 103 | if (indexOfMarker == null) { 104 | try stdout.print("zi interpreter error:\n\n unknown error please make a github issue with the .zi file attached\n\n", .{}); 105 | return 1; 106 | } 107 | 108 | if (tokenList.items.len == 1 or !std.mem.eql(u8, tokenList.items[1], "=")) { 109 | try stdout.print("zi interpreter error:\n\nexpected: = after: {s}\n\n", .{tokenList.items[0]}); 110 | return 1; 111 | } 112 | 113 | if (tokenList.items.len < 3) { 114 | try stdout.print("zi interpreter error:\n\nexpected: (value) after: =\n\n", .{}); 115 | return 1; 116 | } 117 | 118 | var newPsVal = ArrayList(u8).init(allocater); 119 | defer newPsVal.deinit(); 120 | 121 | for (tokenList.items[2..]) |item| { 122 | if (!std.mem.eql(u8, tokenList.items[2], item)) { 123 | try newPsVal.appendSlice(" "); 124 | } 125 | 126 | try newPsVal.appendSlice(item); 127 | } 128 | 129 | try psMarker.appendSlice(newPsVal.items); 130 | } else if (std.mem.startsWith(u8, line, "@shorten")) { 131 | var tokenList = try tokenize(line, allocater); 132 | 133 | defer tokenList.deinit(); 134 | 135 | const indexOfMarker: ?usize = std.mem.indexOf(u8, tokenList.items[0], "@shorten"); 136 | if (indexOfMarker == null) { 137 | try stdout.print("zi interpreter error:\n\n unknown error please make a github issue with the .zi file attached\n\n", .{}); 138 | return 1; 139 | } 140 | 141 | if (tokenList.items.len == 1 or !std.mem.eql(u8, tokenList.items[1], "=")) { 142 | try stdout.print("zi interpreter error:\n\nexpected: = after: {s}\n\n", .{tokenList.items[0]}); 143 | return 1; 144 | } 145 | 146 | if (tokenList.items.len < 3) { 147 | try stdout.print("zi interpreter error:\n\nexpected: (value) after: =\n\n", .{}); 148 | return 1; 149 | } 150 | 151 | var newShortenVal = ArrayList(u8).init(allocater); 152 | defer newShortenVal.deinit(); 153 | 154 | const newShortenKey: []const u8 = tokenList.items[0][indexOfMarker.? + 8 ..]; 155 | 156 | for (tokenList.items[2..]) |item| { 157 | if (!std.mem.eql(u8, tokenList.items[2], item)) { 158 | try newShortenVal.appendSlice(" "); 159 | } 160 | try newShortenVal.appendSlice(item); 161 | } 162 | 163 | // btw this gets deallocated later 164 | const clonedShortenVal = try allocater.alloc(u8, newShortenVal.items.len); 165 | const clonedShortenKey = try allocater.alloc(u8, newShortenKey.len); 166 | std.mem.copyForwards(u8, clonedShortenVal, @constCast(newShortenVal.items)); 167 | std.mem.copyForwards(u8, clonedShortenKey, @constCast(newShortenKey)); 168 | 169 | try shortens.put(clonedShortenKey, clonedShortenVal); 170 | } else if (std.mem.eql(u8, line, "")) { 171 | continue; 172 | } else if (line[0] == '#') { 173 | continue; 174 | } else { 175 | execute.execute(@constCast(line), allocater, false, envVarMap, psMarker) catch |err| { 176 | try stdout.print("zi interpreter error:\n\nexecuted: {s} and it returned {}\n\n", .{ line, err }); 177 | return 1; 178 | }; 179 | } 180 | } 181 | 182 | return 0; 183 | } 184 | 185 | // if this function is called make sure to defer deinit the output 186 | fn tokenize(line: []const u8, allocater: std.mem.Allocator) !std.ArrayList([]const u8) { 187 | var tokens = std.mem.split(u8, line, " "); 188 | var tokenList = ArrayList([]const u8).init(allocater); 189 | 190 | while (tokens.next()) |token| { 191 | try tokenList.append(token); 192 | } 193 | 194 | return tokenList; 195 | } 196 | -------------------------------------------------------------------------------- /src/main.zig: -------------------------------------------------------------------------------- 1 | const std = @import("std"); 2 | const shell = @import("shell.zig"); 3 | 4 | pub fn main() !void { 5 | try shell.shell(); 6 | } 7 | -------------------------------------------------------------------------------- /src/shell.zig: -------------------------------------------------------------------------------- 1 | // purpose: setup the base for the shell 2 | const std = @import("std"); 3 | const exit = @import("commands/exit.zig"); 4 | const cd = @import("commands/cd.zig"); 5 | const marker = @import("utils/marker.zig"); 6 | const config = @import("utils/config.zig"); 7 | const execute = @import("utils/execute.zig"); 8 | const help = @import("commands/help.zig"); 9 | const history = @import("utils/history.zig"); 10 | const historyCMD = @import("commands/history.zig"); 11 | const interpreter = @import("interpreter/interpreter.zig"); 12 | const process = std.process; 13 | const ArrayList = std.ArrayList; 14 | 15 | pub fn shell() !void { 16 | var gpa = std.heap.GeneralPurposeAllocator(.{}){}; 17 | defer _ = gpa.deinit(); 18 | const allocater = gpa.allocator(); 19 | 20 | var psMarker = std.ArrayList(u8).init(allocater); 21 | var envVars = std.StringHashMap([]u8).init(allocater); 22 | var shortens = std.StringHashMap([]u8).init(allocater); 23 | defer { 24 | psMarker.deinit(); 25 | envVars.deinit(); 26 | shortens.deinit(); 27 | } 28 | 29 | const stdin = std.io.getStdIn().reader(); 30 | const stdout = std.io.getStdOut().writer(); 31 | 32 | var args = std.process.args(); 33 | var argsList = ArrayList([]const u8).init(allocater); 34 | defer argsList.deinit(); 35 | 36 | while (args.next()) |arg| { 37 | try argsList.append(arg); 38 | } 39 | 40 | if (argsList.items.len == 2) { 41 | if (try interpreter.runZiFile(argsList.items[1], allocater, &envVars, &shortens, &psMarker) > 0) { 42 | try stdout.print("following errors above occurred in file: {s}\n", .{argsList.items[1]}); 43 | } 44 | try exit.exit(); 45 | } 46 | try config.init(allocater, &envVars, &shortens, &psMarker); 47 | 48 | try history.initHistory(allocater); 49 | try marker.printShellMarker(allocater, &psMarker); 50 | while (true) { 51 | const input: []u8 = try stdin.readUntilDelimiterAlloc(allocater, '\n', 10000); 52 | defer allocater.free(input); 53 | 54 | if (input.len == 0) { 55 | try marker.printShellMarker(allocater, &psMarker); 56 | continue; 57 | } 58 | 59 | if (std.mem.eql(u8, input, "exit")) { 60 | // RELEASE ME 61 | try exit.exit(); 62 | } 63 | 64 | if (std.mem.count(u8, input, "cd") > 0) { 65 | cd.cd(input, allocater, true, &envVars, &psMarker) catch |err| { 66 | try stdout.print("Unknown Error: {}\n", .{err}); 67 | try marker.printShellMarker(allocater, &psMarker); 68 | }; 69 | } else if (std.mem.eql(u8, input, "help")) { 70 | try help.help(allocater, &psMarker); 71 | } else if (std.mem.startsWith(u8, input, "history")) { 72 | try historyCMD.history(input, allocater); 73 | try marker.printShellMarker(allocater, &psMarker); 74 | } else { 75 | var execInput: ?[]const u8 = undefined; 76 | if (shortens.get(input)) |val| { 77 | execInput = val; 78 | } else { 79 | execInput = input; 80 | } 81 | execute.execute(@constCast(execInput.?), allocater, true, &envVars, &psMarker) catch { 82 | try stdout.print("Error Command Not Found\n", .{}); 83 | try marker.printShellMarker(allocater, &psMarker); 84 | }; 85 | } 86 | 87 | try history.addToHistory(allocater, input); 88 | } 89 | } 90 | 91 | fn append(list: *std.ArrayList(u32), val: u32) !void { 92 | try list.append(val); 93 | } 94 | -------------------------------------------------------------------------------- /src/utils/config.zig: -------------------------------------------------------------------------------- 1 | // purpose: provide functions for config support 2 | const std = @import("std"); 3 | const file = @import("file.zig"); 4 | const interpreter = @import("../interpreter/interpreter.zig"); 5 | 6 | pub fn init(allocater: std.mem.Allocator, envVarList: *std.StringHashMap([]u8), shortens: *std.StringHashMap([]u8), psMarker: *std.ArrayList(u8)) !void { 7 | const stdout = std.io.getStdOut().writer(); 8 | 9 | const homeDir = try std.process.getEnvVarOwned(allocater, "HOME"); 10 | const configDot = try std.fs.path.join(allocater, &[_][]const u8{ homeDir, ".config" }); 11 | const ziDir = try std.fs.path.join(allocater, &[_][]const u8{ configDot, "zi" }); 12 | const configDir = try std.fs.path.join(allocater, &[_][]const u8{ ziDir, "rc.zi" }); 13 | 14 | _ = std.fs.cwd().makeDir(configDot) catch {}; 15 | 16 | defer { 17 | allocater.free(configDir); 18 | allocater.free(ziDir); 19 | allocater.free(configDot); 20 | } 21 | 22 | defer allocater.free(homeDir); 23 | 24 | _ = std.fs.cwd().makeDir(ziDir) catch {}; 25 | if (!try file.fileExists(configDir)) { 26 | const defaultConfig = "@defaultPWD = $HOME\n@PS1 = \"[$CWD] zi~>\"\n@shortenls = ls --color=auto\n"; 27 | try file.fileWrite(configDir, defaultConfig); 28 | } else { 29 | if (try interpreter.runZiFile(configDir, allocater, envVarList, shortens, psMarker) > 0) { 30 | try stdout.print("following errors above occurred in file: {s}\n", .{configDir}); 31 | } 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/utils/execute.zig: -------------------------------------------------------------------------------- 1 | // purpose: main way to execute commands 2 | const std = @import("std"); 3 | const ChildProcess = std.process.Child; 4 | const marker = @import("marker.zig"); 5 | 6 | pub fn execute(input: []u8, allocater: std.mem.Allocator, useMarker: bool, map: *std.StringHashMap([]u8), psMarker: *std.ArrayList(u8)) !void { 7 | var cmdArgs = std.mem.split(u8, input, " "); 8 | var args = std.ArrayList([]const u8).init(allocater); 9 | defer args.deinit(); 10 | 11 | while (cmdArgs.next()) |arg| { 12 | var envVar: ?[]const u8 = null; 13 | if (std.mem.count(u8, arg, "$") > 0) { 14 | const indexOfVarMarker: ?usize = std.mem.indexOf(u8, arg, "$"); 15 | if (indexOfVarMarker == null) { 16 | return error.CannotIndex; 17 | } 18 | const envVarKey = arg[indexOfVarMarker.? + 1 ..]; 19 | if (std.process.getEnvVarOwned(allocater, envVarKey)) |val| { 20 | envVar = val; 21 | } else |err| { 22 | if (err == std.process.GetEnvVarOwnedError.EnvironmentVariableNotFound) { 23 | envVar = map.get(envVarKey) orelse null; 24 | } 25 | } 26 | } 27 | if (envVar == null) { 28 | try args.append(arg); 29 | } else { 30 | try args.append(envVar.?); 31 | } 32 | } 33 | 34 | // https://cookbook.ziglang.cc/08-02-external.html only docs i could find on how to do something like this 35 | var cmd = ChildProcess.init(args.items, allocater); 36 | cmd.stdout_behavior = .Inherit; 37 | cmd.stderr_behavior = .Inherit; 38 | 39 | try cmd.spawn(); 40 | _ = cmd.wait() catch |err| { 41 | switch (err) { 42 | error.FileNotFound => { 43 | return error.CommandNotFound; 44 | }, 45 | else => { 46 | return err; 47 | }, 48 | } 49 | }; 50 | if (useMarker) { 51 | try marker.printShellMarker(allocater, psMarker); 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /src/utils/file.zig: -------------------------------------------------------------------------------- 1 | // purpose: provide functions for file handling 2 | const std = @import("std"); 3 | 4 | pub fn fileExists(path: []const u8) !bool { 5 | // https://nofmal.github.io/zig-with-example/file/ kinda stolen from here lol 6 | const file = std.fs.cwd().openFile(path, .{}) catch |err| switch (err) { 7 | error.FileNotFound => return false, 8 | else => return err, 9 | }; 10 | defer file.close(); 11 | return true; 12 | } 13 | 14 | pub fn fileWrite(path: []const u8, data: []const u8) !void { 15 | var file = try std.fs.cwd().createFile(path, .{}); 16 | defer file.close(); 17 | 18 | try file.writeAll(data); 19 | } 20 | 21 | pub fn fileReadAll(path: []const u8, allocater: std.mem.Allocator) ![]u8 { 22 | const file = try std.fs.cwd().openFile(path, .{}); 23 | defer file.close(); 24 | 25 | const out = try file.readToEndAlloc(allocater, 1000000); 26 | 27 | return out; 28 | } 29 | -------------------------------------------------------------------------------- /src/utils/history.zig: -------------------------------------------------------------------------------- 1 | // purpose: allow you to see commands you ran in the past 2 | const std = @import("std"); 3 | const fileUtils = @import("file.zig"); 4 | 5 | pub fn initHistory(allocater: std.mem.Allocator) !void { 6 | const homeDir = try std.process.getEnvVarOwned(allocater, "HOME"); 7 | const cacheDir = try std.fs.path.join(allocater, &[_][]const u8{ homeDir, ".cache" }); 8 | const ziCacheDir = try std.fs.path.join(allocater, &[_][]const u8{ cacheDir, "zi" }); 9 | const historyFile = try std.fs.path.join(allocater, &[_][]const u8{ ziCacheDir, "history.txt" }); 10 | defer { 11 | allocater.free(homeDir); 12 | allocater.free(cacheDir); 13 | allocater.free(ziCacheDir); 14 | allocater.free(historyFile); 15 | } 16 | 17 | _ = std.fs.cwd().makeDir(cacheDir) catch {}; 18 | _ = std.fs.cwd().makeDir(ziCacheDir) catch {}; 19 | if (!try fileUtils.fileExists(historyFile)) { 20 | _ = std.fs.cwd().createFile(historyFile, .{}) catch {}; 21 | } 22 | } 23 | 24 | pub fn addToHistory(allocater: std.mem.Allocator, line: []const u8) !void { 25 | const homeDir = try std.process.getEnvVarOwned(allocater, "HOME"); 26 | const cacheDir = try std.fs.path.join(allocater, &[_][]const u8{ homeDir, ".cache" }); 27 | const ziCacheDir = try std.fs.path.join(allocater, &[_][]const u8{ cacheDir, "zi" }); 28 | const historyFile = try std.fs.path.join(allocater, &[_][]const u8{ ziCacheDir, "history.txt" }); 29 | defer { 30 | allocater.free(homeDir); 31 | allocater.free(cacheDir); 32 | allocater.free(ziCacheDir); 33 | allocater.free(historyFile); 34 | } 35 | 36 | var file = try std.fs.cwd().openFile(historyFile, .{}); 37 | const fullHistory = try file.readToEndAlloc(allocater, 1000000); 38 | var arrayToAppend = std.ArrayList(u8).init(allocater); 39 | 40 | defer { 41 | file.close(); 42 | allocater.free(fullHistory); 43 | arrayToAppend.deinit(); 44 | } 45 | 46 | try arrayToAppend.appendSlice(fullHistory); 47 | try arrayToAppend.appendSlice(line); 48 | try arrayToAppend.appendSlice("\n"); 49 | 50 | var newFile = try std.fs.cwd().createFile(historyFile, .{}); 51 | defer newFile.close(); 52 | try newFile.writer().writeAll(arrayToAppend.items); 53 | } 54 | 55 | pub fn clearHistory(allocater: std.mem.Allocator) !void { 56 | const homeDir = try std.process.getEnvVarOwned(allocater, "HOME"); 57 | const cacheDir = try std.fs.path.join(allocater, &[_][]const u8{ homeDir, ".cache" }); 58 | const ziCacheDir = try std.fs.path.join(allocater, &[_][]const u8{ cacheDir, "zi" }); 59 | const historyFile = try std.fs.path.join(allocater, &[_][]const u8{ ziCacheDir, "history.txt" }); 60 | defer { 61 | allocater.free(homeDir); 62 | allocater.free(cacheDir); 63 | allocater.free(ziCacheDir); 64 | allocater.free(historyFile); 65 | } 66 | 67 | _ = std.fs.cwd().deleteFile(historyFile) catch {}; 68 | 69 | _ = std.fs.cwd().makeDir(cacheDir) catch {}; 70 | _ = std.fs.cwd().makeDir(ziCacheDir) catch {}; 71 | _ = std.fs.cwd().createFile(historyFile, .{}) catch {}; 72 | } 73 | -------------------------------------------------------------------------------- /src/utils/marker.zig: -------------------------------------------------------------------------------- 1 | // purpose: print the marker 2 | const std = @import("std"); 3 | 4 | pub fn printShellMarker(allocater: std.mem.Allocator, psMarker: *std.ArrayList(u8)) !void { 5 | const stdout = std.io.getStdOut().writer(); 6 | 7 | const strippedSize = std.mem.replacementSize(u8, psMarker.items, "\"", ""); 8 | const strippedMarker: []u8 = try allocater.alloc(u8, strippedSize); 9 | defer allocater.free(strippedMarker); 10 | _ = std.mem.replace(u8, psMarker.items, "\"", "", strippedMarker); 11 | 12 | var tokens = try tokenize(strippedMarker, allocater); 13 | defer tokens.deinit(); 14 | 15 | var finalMarker = std.ArrayList(u8).init(allocater); 16 | defer finalMarker.deinit(); 17 | 18 | for (tokens.items) |item| { 19 | if (!std.mem.eql(u8, item, tokens.items[0])) { 20 | try finalMarker.appendSlice(" "); 21 | } 22 | 23 | if (std.mem.count(u8, item, "$CWD") > 0) { 24 | const cwd = try std.fs.cwd().realpathAlloc(allocater, "."); 25 | defer allocater.free(cwd); 26 | var splitCWD = std.mem.split(u8, cwd, "/"); 27 | 28 | var topPathName: ?[]const u8 = undefined; 29 | 30 | while (splitCWD.next()) |split| { 31 | topPathName = split; 32 | } 33 | 34 | if (std.mem.eql(u8, topPathName orelse "", "")) { 35 | topPathName = "/"; 36 | } 37 | 38 | const dir = topPathName orelse ""; 39 | 40 | // https://stackoverflow.com/questions/77550399/how-can-i-replace-all-instances-of-a-character-in-a-string-in-zig 41 | // i love zig but the docs are just not there yet 42 | const size = std.mem.replacementSize(u8, item, "$CWD", dir); 43 | const newItem = try allocater.alloc(u8, size); 44 | defer allocater.free(newItem); 45 | _ = std.mem.replace(u8, item, "$CWD", dir, newItem); 46 | 47 | try finalMarker.appendSlice(newItem); 48 | } else { 49 | try finalMarker.appendSlice(item); 50 | } 51 | } 52 | 53 | try stdout.print("{s}", .{finalMarker.items}); 54 | try stdout.print(" ", .{}); 55 | } 56 | 57 | fn tokenize(line: []const u8, allocater: std.mem.Allocator) !std.ArrayList([]const u8) { 58 | var tokens = std.mem.split(u8, line, " "); 59 | var tokenList = std.ArrayList([]const u8).init(allocater); 60 | 61 | while (tokens.next()) |token| { 62 | try tokenList.append(token); 63 | } 64 | 65 | return tokenList; 66 | } 67 | --------------------------------------------------------------------------------