summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* Add a license filedocsRory Dudley2024-04-112-1/+10
| | | | dwvsh is licensed under the BSD 2 Clause license.
* Create the dwvsh(1) manual pageRory Dudley2024-04-111-0/+132
| | | | | | | | | This patch adds a cursory man page for the dwvsh binary. Notes: This man page is incomplete. In addition to continuing updating it as the shell gains more features, some more info should be provided about how the shell works in general.
* 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 support for aliases to the `which` commandRory Dudley2024-04-041-0/+3
| | | | | | The `which` command is not necessarily a builtin, however, it can display shell aliases. This patch adds a line into dist/etc/dwvshrc, which allows /usr/bin/which to detect our shell aliases, and print them.
* 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-302-17/+29
| | | | | 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-287-81/+100
| | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* Update description in Cargo.tomlRory Dudley2024-03-261-1/+1
| | | | | Updated the description in Cargo.toml to fix a typo, as well as add a clarification for the POSIX compliance.
* 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.
* Fix macro_export formattingRory Dudley2024-03-051-2/+2
| | | | | Fixed formatting of macro_export in src/recite/ps.rs to be more consistent.
* Add unit tests for the new IO metersRory Dudley2024-03-031-0/+74
| | | | | | | Added six new units tests related to the IO meters (Read, Write, and Addendum). The first three tests check the meters under normal operation , and the last three tests ensures that the parser throws an error, unless one or more files where specified for the operation.
* Clear the buffer for STDIN after incant_write/incant_addendumRory Dudley2024-03-021-0/+6
| | | | | Clear the 'out' buffer after we have written STDOUT to the files specified after the Meter::Write or Meter::Addendum verse.
* Cleanup commentsRory Dudley2024-03-021-24/+0
| | | | | | | Remove commented code relating to error checks for the incant_io functions. The parser should detect if no files where specified for Meter::Read, Meter::Write, or Meter::Addendum, meaning that these checks are not necessary.
* Add file redirection capabilitiesRory Dudley2024-03-021-14/+337
| | | | | | | | | | | Added the following file redirection capabilies: - '<': Read input into STDIN - '>': Write STDOUT to file - '>>': Append STDOUT to file If no files are specified, this counts as a parser error, and so no code will be executed, even when used in combination with the string (';') meter. Currently, there is no way to redirect STDERR.
* Fix handling of SIGINTRory Dudley2024-02-293-6/+53
| | | | | | | | | | | | | | | 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
* Change runner typeghaRory Dudley2024-02-291-3/+3
| | | | The 'debian-latest' isn't a real runner, so change to 'ubuntu-latest'.
* Github actionsRory Dudley2024-02-291-0/+59
| | | | | Add a yaml file to run `cargo check`, `cargo fmt`, and `cargo test`, every time a branch is pushed, or every time a pull request is made.
* Parser testspipesRory Dudley2024-02-291-0/+157
| | | | Added twelve different tests for the parser (Poem::read).
* Parsing poems from a fileRory Dudley2024-02-291-0/+22
| | | | | | Added a match statement in the main parser loop that pushes a new verse into the poem if a newline is found. This might happen if parsing a poem from a file.
* 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.
* Add doc comments for incant_ functionsRory Dudley2024-02-281-0/+43
| | | | | Added documentation comments for the Meter::incant_ functions, describing how each function operates.
* Parser comments and error checkingRory Dudley2024-02-281-9/+22
| | | | | | | | | Added an index to keep track of what position each char is at in the loop. Added a more verbose error message, which prints out the column that the parse error was detected, as well as the glyph that threw the error. Added more comments to the '&', whitespace, and char match statements. Changed parser behavior, so that a ';' glyph without a stanza does not cause a parser error.
* Refactor status variables in Poem::read()Rory Dudley2024-02-281-28/+29
| | | | | | | Moved the 'couplet' and 'metered' variables into functions impl'd for Verse. This cuts down on the boilerplate in the parsing loop, and also makes it so that their match statements are only ran when needed, rather than being called at every iteration of the loop.
* Fix && behavior regressionrmerrRory Dudley2024-02-281-9/+9
| | | | | | Introduce a switch to break from recite() if the forked process returns a non-zero exit code. The one except to this, is when using semicolons, then we do not care if the previous command failed.