summaryrefslogtreecommitdiffstats
path: root/src
Commit message (Collapse)AuthorAgeFilesLines
* Fix capturing output for internal poemsRory Dudley2024-06-213-1/+14
| | | | | | | | | | Sometime when the switch to the new built-in command system was happening, we lost the logic to force the capture the output of STDOUT, mainly used for running internal poems (i.e. 'ls `ls`'). This patch adds a new field to the Environment struct, called fc (force capture). It gets set to true before running internal poems, and unset afterwards. Finally, some checks were added to the incant!() macro to properly handle STDOUT when fc is set.
* Add back spellcheckRory Dudley2024-06-144-88/+64
| | | | | | | | | | | | | | This commit reworks spellcheck() so it is more verbose about what it returns. It also re-introduces the use of spellcheck() in Poem::recite(). Spellcheck now returns a value in the enum, Spelling: FullPath -> Indicates a full path was specified as the verb OnPath -> Indicates the verb is on the $PATH BuiltIn -> Indicates the verb is a built-in command None (Option) -> The verb does not exist This commit also removes some defunct (commented-out) code.
* Updated the way built-in commands are called/usedRory Dudley2024-06-0412-314/+650
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously, built-in commands were fairly primitive, merely outputting STDOUT and STDERR with the print! macros. However, we need them to behave like normal programs, that is: - Acknowledge their verse's meter (forking, piping, etc.), - Ability to capture STDOUT and STDERR (>, 2>), - and Affect the currently running environment. For these reasons, the anthology was reworked, and now contains the Anthology struct, which mimics both std::process::{Child, Command}. The AnthologyStdin helper struct was also created, for built-ins to take input on STDIN, though no built-in is currently using it. Each built-ins' incant functions were updated to return a std::process::Output. It contains output from STDOUT, output from STDERR, and the exit code of the "process". A fix was also implemented for aliases, where the STDOUT and STDERR vectors were not being copied to the newly constructed verse. Notes: There is some cleanup that needs to happen on this patch. For one, the spellcheck function is no longer being used, so there is a generic OS error if the program cannot be found in the $PATH. Also, anthology::lookup gets called twice, which shouldn't need to happen.
* Added the 'which' built-in commandRory Dudley2024-05-202-2/+65
| | | | | | Added a built-in which command (for MacOS and BSD), which can check aliases, and other shell built-in commands, in addition to bins on the $PATH.
* Update the return value of Verse::spellcheck()Rory Dudley2024-05-202-14/+15
| | | | | | | | | | | | | Instead of returning true or false, if a given bin is found on the $PATH, return the index of where the bin was found. This is useful, in case we want to actually get the full path of the bin. If a full or relative path is specified, the function will return the length of the bins vector. Notes: This is primarily useful for the built-in 'which' command, so that we can print out the full bin path without invoking /usr/bin/which.
* Added doc comments for Poem::recite()Rory Dudley2024-05-201-0/+8
| | | | | | Added documentation comments for the Poem::recite() function, detailing what the purpose of the function is, as well as what operations it performs.
* Updated/added doc comments for the Verse elementRory Dudley2024-05-201-4/+61
| | | | | | | | | | Added definitions of fields for the Verse struct, and updated its wording to accomodate for the type change of the couplet field. Updated the wording of Verse::add() to make it more verbose, and also added descriptions of the arguments, alongside some example usage. Added documentation comments for the Verse::incant() function.
* Update doc comments for RunesRory Dudley2024-05-201-0/+4
| | | | | Added documentation comments for the new Runes that help with handling file redirection of STDERR.
* Update doc comments for Poem::read functionsRory Dudley2024-05-201-3/+16
| | | | | Update documentation comments for the Poem::read() function, as well as the Poem::add() function (which is crucial for read()).
* Add doc comments for the Environment structRory Dudley2024-05-201-0/+25
| | | | | Added documentation comments for the Environment struct, which includes uses cases, and defining the fields.
* Allow aliases with the same name as their verbRory Dudley2024-05-204-44/+56
| | | | | | | | | | | | | | | | | Previously, when trying to add an alias that used the same name as its command, an infinite recursion loop would occur, and the program would panic after the call stack got too deep. For instance, something like: alias grep='grep --color=always' would cause it to panic. This patch adds a new field to the Environment struct called 'cs' (for call stack), which can be used to keep track of how many levels deep into the Poem::read() function we are in. At the moment, it only allows going two levels deep, but since it's just a u8 value, this could be increased in the future. The above example now works correctly, but it does mean that aliases within aliases are not possible, currently.
* Don't clear 'out' unconditionallyRory Dudley2024-05-202-2/+3
| | | | | Only clear the 'out' vector when the verse is not a couplet, otherwise text will not be piped to the next verse in the poem.
* Handle STDERR, in addition to STDOUTRory Dudley2024-05-1911-563/+566
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch overhauls the reading and reciting of verses, such that the redirection of STDERR (in addition to STDOUT, which was already a feature), is now possible. Removed the 'stdout' argument from recite(), since it is no longer needed with how incantations function. A verse's couplet indicator is now a u8, instead of a bool, with certain values corresponding to types of couplets, for instance: ls | grep Ca | lolcat ^ ^ ^ | | 2: right side of a couplet | 3: both sides of a couplet 1: left side of a couplet Incantions are no longer hanlded in rune.rs, and the task macros have been removed. Now, a verse incants itself, matching on its own meter to determine how to handle the next verse. The following runes were added to help with handling STDERR: Write2 -> 2> WriteAll -> &> Addendum2 -> 2>> AddendumAll -> &>> The 'io' field in verse was changed from an Option<Rune>, to an array of Runes, since a single verse might have multiple IO operations. The following fields were added to Verse, to assist with handling STDERR: ip -> List of filenames to read into STDIN op -> List of filenames to send STDOUT to ep -> List of filenames to send STDERR to Keep track of channels when reading a poem. Channels are relating to IO operations. If channel is None, words get pushed to the verse's primary stanza (i.e. the verb or the clause). If a channel is selected, words are pushed to one of the aforementioned new fields in Verse. Read -> ip Write/Addedum -> op Write2/Addedum2 -> ep WriteAll/AddendumAll -> op and ep Notes: This commit also added tests for the new Runes.
* Remove into_iter() for Chars in new next() functionRory Dudley2024-05-171-1/+1
| | | | | The instance of &mut Chars is already an iterator, so we can remove the call to into_iter().
* Rewrite of the next! macroRory Dudley2024-05-172-14/+38
| | | | | | | This patch replaces the next! macro with a next() function. It serves the same purpose, but instead of only checking for two different runes (a fallback, or one that matches the peek), it can now take a list of runes/characters to look ahead for, in addition to the fallback.
* Remove a println!()Rory Dudley2024-05-161-1/+0
| | | | | Removed a println!() that was used for debugging, and was accidentally left in.
* Fix another another regression with aliasesRory Dudley2024-05-131-1/+4
| | | | | | For aliases, only set couplet for the last verse, if the original verse has its couplet set. Otherwise, the alias could have trouble with piping.
* Fix another regression with aliasesRory Dudley2024-05-131-17/+11
| | | | | | | | The last commit (1415c8f9b89699000ef8d864ff8f0e1bebca4a5f) fixed the issue with pipes, however, it did not fix it for IO. This patch adds some logic for the aliased verse to inherit the properties of the original verse, so that recite works properly for all verse types (regardless of IO, couplet, or meter).
* Fix regression with aliasesRory Dudley2024-05-122-42/+65
| | | | | | | | | Fixed a regression that was introduced in: 1415c8f9b89699000ef8d864ff8f0e1bebca4a5f. Moving aliases to read() broke how pipes worked. This commit removes the troublesome append!() macro, and replaces it with some logic in the add() function (impl Appendable for Poem).
* Remove some defunct codeRory Dudley2024-05-041-8/+0
| | | | | Remove some defunct code that was previously used to check for special runes.
* Sort output of 'export' and 'alias'Rory Dudley2024-04-112-2/+6
| | | | | Sort the output of the built-in 'export' and 'alias' commands, in cases where all environment variables/aliases are printed out.
* Add 'strings' to the verse after the string!() macroRory Dudley2024-04-062-1/+4
| | | | | | This patches fixes a bug, where sometimes, when a Rune::String was detected, the resulting string from the string!() macro wasn't getting pushed to the current verse.
* Capture STDOUT as bytes, and convert to string when necessaryRory Dudley2024-04-066-49/+77
| | | | | | | | | | | | | Previously, the recite() function created the 'out' variable, which was a String, that got passed to the various incant functions, in order to capture STDOUT in certain situations. In cases where STDOUT was captured, it was first converted to a String, and then appended to the 'out' variable, by means of String::from_utf8_lossy(). This works for basic text, however, does NOT work for binary data. This becomes problematic, when for example, downling a tar file with curl/wget, that is then piped ('|') to the tar program. Using from_utf8_lossy() in this case can corrupt the tar file. This patch makes it so that out is stored as bytes by default, and only converted to a String when necessary.
* Handle aliases in read()Rory Dudley2024-04-048-75/+98
| | | | | | Instead of handling aliases in the recite() function, which requires two loops to handle properly with the current implementation, offload checking for aliases to the read() function.
* Add better support for aliasesRory Dudley2024-04-044-29/+50
| | | | | | | | | | | | | | | Make sure to interpret alias values as their own poems, since aliases can be fairly complex. Notes: Previously, I was doing a simple find and replace for aliases within each verse. However, aliases can be fairly complex, containing their own range of meters, commands, and io operations. This could cause problems, since a verse should never have, for instance, a pipe (`|`) in the middle of it. This patch fixes it, so that we iterate once through the poem, generating a new poem based on aliases that are found. In order to avoid two loops in the recite() function, it might make sense to offload handling aliases to read().
* Document aliases in the docstring for lookup()Rory Dudley2024-03-311-0/+4
| | | | | Add documentation for anthology::lookup(), with a list containing all the default aliases for builtin commands.
* Add docstring comments to all the anthology functionsRory Dudley2024-03-316-1/+85
| | | | | | Add docstring comments for all the incant function throughout the anthology, documenting what each function does, and an example of it's shell command.
* Don't interpret environment variables in single quoted stringscomposeRory Dudley2024-03-312-0/+9
| | | | | | | | | | | | Previously, if an environment variable was given in a string, such as: '$PATH' or "$PATH", both would be replaced with the value of $PATH from the environment. However, for single quotes strings, any values inside should be taken at face value. In other words, echo '$PATH' should simply write out: $PATH, and not whatever environment value $PATH happens to be. This patch replaced '$' in single quoted strings with the ASCII shift out (x0e) character. Any ASCII SO placeholder is replaced with a '$' in recite(), after the environment variables have been accounted for.
* Use $PS1 for the promptRory Dudley2024-03-301-17/+25
| | | | | Instead of passing a hard-coded value for the prompt, use $PS1. The default is '|> ', set in dist/etc/dwvshrc.
* Replace env!("HOME") with env::var("HOME")Rory Dudley2024-03-303-5/+20
| | | | | | Replaced all (non-test) instances of env!("HOME") with env::var("HOME"). The env! macro should only be used in instances where the environment variable should be resolved during compile time.
* Better comments in recite()Rory Dudley2024-03-301-5/+9
| | | | | Add some better comments/move around existing comments to make some of the actions in recite() more clear.
* Fix a subtle bug when running interal poemsRory Dudley2024-03-301-3/+6
| | | | | | | | | | | | | | This patch fixes a bug for internal poems, where the output would always get split on newlines, regardless of the verse's verb. This breaks things like 'export DIR=`ls`', since output from `ls` might have newlines, meaning that $DIR will only contains the first item from the `ls` command. This will only perform the newline split when sending the output to a non-builtin command. Notes: This fix works for export (and alias), but could cause issues with other builtins in the future. Worth keeping an eye on this, as this probably isn't a perfect solution.
* Add the 'unset' built-in commandRory Dudley2024-03-302-1/+19
| | | | | Add the 'unset' command to remove global environment variable definitions from the shell.
* Add the 'alias' built-in commandRory Dudley2024-03-304-13/+81
| | | | | | | | | | | The shell now has support for aliases (via alias foo=bar). The 'unalias' command is also available to remove aliases. Finally, Environment::aliases was changed to be a HashMap<String, String>, instead of a Vec<String>. Since the verse's verb might change (for instance, it is an environment variable, or an alias), add another check in Poem::recite, which simply continues, instead of running the spellchecker, if the verb is empty.
* Fix the buildRory Dudley2024-03-301-0/+1
| | | | Need to include line to import compose::Environment.
* Add wrapper for global shell environmentRory Dudley2024-03-306-22/+45
| | | | | | | | Instead of having to pass around a bunch of different data structures for various shell functions, create the wrapper compose::Environment, which serves as a global shell state. It is configured via login/profile/rc scripts initially, but can of course be modified throughout the lifetime of the shell.
* Remove hard-coded PATHRory Dudley2024-03-286-81/+97
| | | | | | | | | | | | | | | | | | | | | | | | | | Use $PATH, instead of a hard-coded PATH from main(). This means that there is no longer a need to pass around PATH to repl()/recite()/path::refresh(), since path::refresh() can call env::var directly. Since the hard-coded paths were removed, there needs to be some way to define $PATH. When running the debug build, dwvsh will look in 'dist/etc/dwvshrc' for the initial environment setup. For the release target, dwvsh will look in '/etc/dwvshrc'. After the global rc file is sourced, dwvsh will try to source ~/.dwvshrc if it exists, so users can extend their environment without root access (assuming a release install). Notes: Throughout a lot of this program, we're calling `env!("HOME")`, in order to get the user's home directory. Technically, this is not correct. The env!() macro resolves environment variables during compile time, while env::var() gets environment variables for the running process (i.e. the shell). See https://users.rust-lang.org/t/env-vs-env-var/88119 for more info. In the near future, this will need to be addressed. Might be worth looking into what other shells do, though one idea I had was to invoke '/usr/bin/id', grab the user's ID, and use it to grab the rest of the info from /etc/passwd. This would be handled in an /etc/dwvlogin or /etc/dwvprofile most likely.
* The anthology moduleRory Dudley2024-03-287-57/+190
| | | | | | The anthology module was added to run built-in commands. The 'cd' and 'exit' built-ins were moved from the main recite() loop to this module. Additionally, the 'export' and 'source' built-ins were added.
* Add comments (`#`) to the parserRory Dudley2024-03-283-2/+24
| | | | | The parser will now interpret the '#' character as a single-line comment string, which works on it's own line, or at the end of an existing line.
* Update docs for repl()readRory Dudley2024-03-281-2/+4
| | | | | Updated the docs for repl() in main.rs, to include the 'at_prompt' function parameter.
* Don't error on dir read errorsRory Dudley2024-03-261-11/+5
| | | | | | Previously, if a directory could not be read, dwvsh would panic. Instead of panicking, dwvsh should continue processing the other directories on the $PATH.
* Rename prefresh()Rory Dudley2024-03-263-4/+6
| | | | | | Rename the path::prefresh() function to path::refresh(). Calling convention should be to `use crate::path;` or `mod path;`, and then call path::refresh(...), for verbosity.
* Remove unecessary double quotesRory Dudley2024-03-261-1/+1
| | | | Don't need double quotes if just printing a newline.
* Poem testingRory Dudley2024-03-241-46/+50
| | | | | | Add back tests for Rune::Read, Rune::Write, and Rune::Addendum, following the new parser output. Also, renames some tests, since Read, Write, and Addendum are no longer meters.
* Remove defunct code from read() and recite()Rory Dudley2024-03-242-27/+0
| | | | | Remove some commented out code, that is no longer needed after the parser overhaul.
* Documentation for incant_Rory Dudley2024-03-241-0/+1
| | | | Add docstring for `incant_quiet_io`.
* Remove debug lineRory Dudley2024-03-241-2/+0
| | | | Remove println!() in main that was used for debugging the parser output.
* Fix tests for githubRory Dudley2024-03-231-2/+2
| | | | | Fix the ~ test, so that it uses env!("HOME"), instead of my hard-coded home directory.
* read() and recite() overhaulRory Dudley2024-03-2314-1195/+1438
| | | | | | | | | | | | | | | | | | | | | | | | | 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-052-234/+189
| | | | | | | | | | | | | | 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.