summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* Refactor Verse::clause()Rory Dudley2024-09-024-16/+14
| | | | | | | | There is no reason to return an option for clause(), since it makes us perform a match twice, and since a blank vector is perfectly acceptable in all cases where the verse at hand may not have a clause. Signed-off-by: Rory Dudley <rory@netc.lu>
* Merge branch 'main' into escsqRory Dudley2024-09-013-0/+29
|\
| * Allow escaping charactersRory Dudley2024-09-013-0/+29
| | | | | | | | | | This patch adds the '\' character as a new rune, Rune::Special. This is for escaping special characters. Also works in strings (", ').
* | Slight refactor of getchar() and more handling for getline()Rory Dudley2024-09-012-33/+129
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The getchar() function was changed so that it is able to detect some ANSI escape sequences. To better handle this, getchar() now returns a value from the Key enum, indicating whether or not an escape sequence was found. Currently, the only escape sequences the function deals with are arrow keys. Handling of the left and right arrow keys were added to the getline() function, in order to allow a user to go back and edit their command inplace. Up and down arrow keys are also handled, but they are just ignored for now (i.e. they do not move the cursor around anymore). The local 'pos' variable became an Arc<Mutex<usize>>, since it needs to be reset to 0 if ctrl-c is pressed (the handler for which is outside the scope of getline()).
* | Keep track of position in getline()Rory Dudley2024-08-281-0/+10
| | | | | | | | | | Keep track of the cursor position in getline(), this way it is not possible to backspace the prompt.
* | Replace io::stdin().read_line() with custom functionRory Dudley2024-08-244-12/+97
|/ | | | | | | | | | | | | | | | | | | | | | | | | Added the termios crate to facilitate the changing of certain terminal options. It is a wrapper around the termios C library, so 'man 3 termios' for more details. Added the custom getchar() function, with retrieves characters from STDIN as they are typed by the user (as opposed to waiting for a newline, like io::stdin().read_line()). This is necessary, since keys like <tab> and <up> have special functionality, which needs to be acted on before command submission. Added the custom getline() function, which uses getchar() to read characters as they are typed. The getline() function contains the logic for the various key presses. For most characters, we simply push the byte to a buffer, and print it out to the screen (since getline() assumes ECHO is off). Notes: For now, <tab> autocomplete is not finished, so hitting the tab key only replaces the tabs with spaces in the inbut buffer. Also, some edge cases are unhandled in getline(). For instance, using the arrow keys appears to move the cursor keys. The parser gets upset when you move the cursor then try to submit a command, so this needs to be fixed.
* Ignore patch filesRory Dudley2024-08-101-0/+1
| | | | | | Ignore patch files generated by 'git format-patch'. Signed-off-by: Rory Dudley <rory@netc.lu>
* Fix rc logicRory Dudley2024-08-091-1/+1
| | | | | | | Accidentally sourced 'dist/etc/dwvshrc' twice, instead of sourcing 'dist/etc/linuxrc' for Linux distros. Signed-off-by: Rory Dudley <rory@netc.lu>
* Split OS-specific run commands into a different fileRory Dudley2024-08-092-6/+7
| | | | | | | | Do not run certain commands, except on specific operating systems, when calling the global run command file. This allows users to avoid having unaliases and unsets in their user-defined rc file (~/.dwvshrc). Signed-off-by: Rory Dudley <rory@netc.lu>
* Better handling for run command filesRory Dudley2024-08-091-49/+56
| | | | | | | | | | Rewrites the compose::env() function to be more modular, concerning the run command files to read in. Also, the rrr() function now takes a vector of files to read in. If a file is missing, even the global rc file, it is skipped, instead of an error being thrown, and the shell exiting. Signed-off-by: Rory Dudley <rory@netc.lu>
* Add metadata to Cargo.tomlRory Dudley2024-07-202-1/+4
| | | | | | | | | | | This patch adds the following metadata fields to Cargo.toml, so that the package can be published on https://crates.io: - homepage: Our main website - documentation: Also our main website (no docs for now, but they will end up being hosted here in the near future) - repository: A link to the git server with the source Signed-off-by: Rory Dudley <rory@netc.lu>
* Change how build environment variable is setRory Dudley2024-07-201-1/+1
| | | | | | | | | | It appears that some older versions of the Rust compiler do not like the double colon syntax when setting environment variables for the build process. Until the latest cargo release will only accept the double colon syntax, use a single colon when setting environment variables in build.rs. Signed-off-by: Rory Dudley <rory@netc.lu>
* Alpha Release 1 (v0.0.1)v0.0.1Rory Dudley2024-07-181-1/+1
| | | | Signed-off-by: Rory Dudley <rory@netc.lu>
* Add an open source licenseRory Dudley2024-07-162-1/+29
| | | | | | | This patch licences the repository under the BSD 3-Clause license (https://choosealicense.com/licenses/bsd-3-clause/). Signed-off-by: Rory Dudley <rory@netc.lu>
* Display less characters from the commit hashRory Dudley2024-07-161-1/+1
| | | | | | | | | | The '--version' option prints out the program version, along with the first 10 characters of the git commit hash, indicating at what commit the program was built. This patch reduces the length of the commit hash that gets embeded in the dwvsh binary to 7 characters, as that should be more than enought to determine the correct commit. Signed-off-by: Rory Dudley <rory@netc.lu>
* Allow passing a filename to dwvshRory Dudley2024-07-081-2/+29
| | | | | | The dwvsh binary may optionally take a filename as the last argument. Instead of spawning an interactive shell, it will instead run a shell program at the path specified.
* Fix a bug with channelsRory Dudley2024-07-081-2/+8
| | | | | | | | | When using IO operations from within a file, the channel would get overriden before pushing a filename to the appropriate vector (op, ep, or both). This is because Rune::Continue is used for newlines, and was resetting the channel to None, before the push operation. Rune::Continue is now broken out into its own match clause, that doesn't set the channel before calling verse.add().
* Option parsing and versionRory Dudley2024-07-032-0/+33
| | | | | | | Add some basic logic for parsing commandline arguments. Also, use build.rs to embed the program version (and git commit) during the compile step. The program currently accepts the '--version' commandline argument to print the version, then quit.
* Fix a bug with environment variables in the shellRory Dudley2024-07-031-1/+1
| | | | | | | | The code to find and replace environment variables was only searching for alphanumeric characters. This means that the shell was unable to recognize environment variables that used an underscore, for instance. This patch allows the underscore character to be used when settings and reading environment variables.
* Docs job for Github workflowsanthologyRory Dudley2024-06-301-0/+18
| | | | Add a job for Github workflows that tests building the documentation.
* Add/update doc commentsRory Dudley2024-06-3016-160/+351
| | | | | This patch update a ton of the documentation comments throughout the codebase, refactoring some areas, and adding new comments to others.
* 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.
* Alias grep to always use colorRory Dudley2024-05-201-0/+3
| | | | | In the global /etc/dwvshrc file, alias grep so that it always displays with color by default.
* 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 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.