summaryrefslogtreecommitdiffstats
path: root/src/recite
Commit message (Collapse)AuthorAgeFilesLines
* read() and recite() overhaulRory Dudley2024-03-233-272/+0
| | | | | | | | | | | | | | | | | | | | | | | | | Rebuilt the LR parser (i.e. read()) from the ground up. This required that some changes be made to recite(), in order to accomodate the new data structures. These data structures were each split out into their own file, in order to make working with each component a bit easier. In addition to reworking the parts of the parser already present, some new features were also added, such as: - Support for strings (' and ") - Support for environment variables ($) - Support for interpreting tild as $HOME (~) - Support for sub-reading and sub-reciting (`) Notes: This is a huge commit that changes almost the entire program (main.rs is still the same, except for imports). Ideally, huge sweeping changes like this should not occur on the codebase, but since this is still pre-alpha, I guess this is acceptable. This is far from the end of patch set, however, as there is quite a lot of cleanup that needs to be done. For instance, checking for internal poems and environment variables should get split out to their own functions/macros. There is also some defunct code (that's commented out), that is unlikely to be useful in the future.
* Poem::read macrosRory Dudley2024-03-051-0/+135
| | | | | | | | | | | | | | Added the following macros: push!: Creates a Verse from a stanza, taking into account some extra options (such as the Meter). push1!: Creates a Verse from a stanza, but also allows looking ahead by a single character, in order to pattern match certain meters (i.e. And ('&&') and Addendum ('>>')). Replaced the code in the huge, redundant match statements in Poem::read with the macros described above.
* Fix macro_export formattingRory Dudley2024-03-051-2/+2
| | | | | Fixed formatting of macro_export in src/recite/ps.rs to be more consistent.
* Fix handling of SIGINTRory Dudley2024-02-291-0/+33
| | | | | | | | | | | | | | | Keep track of a new atomic variable: at_prompt, which is set to true just before blocking on io::stdin.read_line, and set to false just calling Poem::read. Additionally, for background tasks, there is a new ps macro called btask, which changes the process group of commands that are forked into the background, so that they don't receive SIGINT from the keyboard. Notes: Changing the process group on the Command is done via CommandExt. More details here: https://doc.rust-lang.org/std/os/unix/process/trait.CommandExt.html#tymethod.process_group
* Fix ps macros doc commentsRory Dudley2024-02-281-5/+5
| | | | | [Verse] is not in scope for the ps module, so removed the link in the documentation comments.
* Add doc comments for ps macrosRory Dudley2024-02-281-0/+19
| | | | | Added documentation comments for the recite::ps::task and recite::ps::ctask macros.
* Remove custom errors and fix background forkingRory Dudley2024-02-272-51/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Removes the custom errors in src/recite/erro.rs, and replaces them with std::io::Errors throughout (recite(), incant_, macros). Fixed a bug with the way forking to the background is handled, where registering the signal handler in main for all processes would break couplets (i.e. pipes). Instead, this sets up a new signal handler each time a process is forked into the background. It uses a Vec<i32> to keep track of all the background processes. Notes: First off, there is some defunct code in the main repl loop, which is an example of killing zombie processes after each prompt. This should be removed, but I kept it in, just in case I go back to it for some reason. To be honest, I have no clue why this code works. In theory, I should have to remove the pid from the pids: Vec<i32> if waitpid returns a positive integer. However, when I tried this, it completely broke the program. ¯\_(ツ)_/¯ Also, it's worth noting that registering a signal handler with signal_hook::low_level::register, is somewhat costly, according to their docs. Given that this only occurs for background processes that are forked, however, I think it is acceptable. Finally, we never unregister the signal handler, so I'm not sure if that's still hanging out in memory somewhere or no.
* Cleanup recite(), custom errors, fixed forkingRory Dudley2024-02-262-0/+86
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | First off, moved the giant match statements out of recite(), and into macros in src/recite/ps.rs. There still needs to be two, since any verse using the 'couplet' meter will need to redirect its STDOUT. Now the recite() function returns a Result<(), Mishap>, which can be invoked when calling the incant_ functions. Custom errors were added in the form of 'Mishap''s. They are intended to be returned from the incant_ functions, in the event that something goes wrong with the Command::spawn() or Child::wait(). They each take a String, which should be the verb or stanza that was entered by the user. The incant_ functions separate the functionality of each type of meter from the recite() function. They return a Result<i32, Mishap>, where i32 is the exit code of the program that ran, and Mishap is a possible error. Before, the shell was cheating at forking a process to the background. It would actually spawn a thread to wait for that process to finish. Now, the program simply registers a handler for SIGCHLD, and uses libc's waitpid() function to reap the child process, and print some output to the user, indicating that it's finished. Notes: This was a huge patch which did some desperately needed cleanup of the recite() function. Moving forward, will need to add more documentation, and will probably scrap the custom errors, since this implementation is a little half-baked. It's worth looking into in the future, but we can probably live with io::Error's for the time being. Fixing forking was a pretty big deal, though. In Linux, and other u**x-like operating systems, parent processes need to reap their child processes, otherwise they become zombies. Previously, the dwvsh did this by spawning a separate thread to wait for child processes that were forked to the background. Now, we are registering a handle for SIGCHLD, which is a signal that gets sent to the parent when one of their children finishes, or is killed. Using waitpid(2), we can determine which process ended, and do something about it. In the case of a processes that was forked into the background, when it finished, waitpid(2) will return its PID. For foreground processes, it returns -1.
* Reorganization and commentsRory Dudley2024-02-221-0/+42
Broke out the structs for a poem into their own file: src/recite.rs. Also put the 'prefresh' function into it's own file: src/recite/path.rs. Commented most of the parser code (including structs and helper methods related to parsing (i.e. Verse, Stanza, Meter, Poem)). Renamed any instance of the 'paths' variable to 'path'. Notes: The biggest task now is to cleanup Poem::recite. It has a ton of bogus error messages, and (seemingly) redundant code.