Simple, extendable and embeddable scripting language.
+This library is the actual script parser and runner.
+On it's own, it has no actual commands as those need to be provided externally (see duckscript_sdk).
In order to use this library, just add it as a dependency:
+[dependencies]
+duckscript = "*"
+Developed by Sagie Gur-Ari and licensed under the +Apache 2 open source license.
+| parser | parser + |
| runner | runner + |
| types | types + |
pub fn parse_file(file: &str) -> Result<Vec<Instruction>, ScriptError>
parses the file and returns a vector of instructions
+pub fn parse_text(text: &str) -> Result<Vec<Instruction>, ScriptError>
parses the provided script text and returns a vector of instructions
+The duck script parser.
+| parse_file | parses the file and returns a vector of instructions + |
| parse_text | parses the provided script text and returns a vector of instructions + |
pub fn run_instruction(
commands: &mut Commands,
variables: &mut HashMap<String, String>,
state: &mut HashMap<String, StateValue>,
instructions: &Vec<Instruction>,
instruction: Instruction,
line: usize
) -> (CommandResult, Option<String>)
Enables to evaluate a single instruction and return its result.
+pub fn run_script(text: &str, context: Context) -> Result<Context, ScriptError>
Executes the provided script with the given context
+pub fn run_script_file(
file: &str,
context: Context
) -> Result<Context, ScriptError>
Executes the provided script file with the given context
+The main entry point which enables running scripts.
+| run_instruction | Enables to evaluate a single instruction and return its result. + |
| run_script | Executes the provided script with the given context + |
| run_script_file | Executes the provided script file with the given context + |
Command execution result
+Continue(Option<String>)Holds the command output and tells the runner to continue to next instruction
+GoTo(Option<String>, GoToValue)Holds the command output and tells the runner to jump to the provided label
+Error(String)Holds the error message and the meta info of the instruction that caused it
+Crash(String)Holds the critical error message and the meta info of the instruction that caused it
+Exit(Option<String>)Holds the command output and tells the runner to stop the script execution
+impl Clone for CommandResult[src]fn clone(&self) -> CommandResult[src]fn clone_from(&mut self, source: &Self)1.0.0[src]Performs copy-assignment from source. Read more
impl Debug for CommandResult[src]impl Send for CommandResultimpl Unpin for CommandResultimpl Sync for CommandResultimpl RefUnwindSafe for CommandResultimpl UnwindSafe for CommandResultimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+fn to_owned(&self) -> T[src]fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]GoTo type value
+Label(String)label target
+Line(usize)Line number
+impl Clone for GoToValue[src]fn clone(&self) -> GoToValue[src]fn clone_from(&mut self, source: &Self)1.0.0[src]Performs copy-assignment from source. Read more
impl Debug for GoToValue[src]impl Send for GoToValueimpl Unpin for GoToValueimpl Sync for GoToValueimpl RefUnwindSafe for GoToValueimpl UnwindSafe for GoToValueimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+fn to_owned(&self) -> T[src]fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]The command trait and access module.
+| Commands | Holds and enables access to the runtime commands implementations + |
| CommandResult | Command execution result + |
| GoToValue | GoTo type value + |
| Command | Defines the command capabilities + |
Holds and enables access to the runtime commands implementations
+commands: HashMap<String, Box<dyn Command>>mapping between command names to implementations
+aliases: HashMap<String, String>mapping between aliases to command names
+impl Commands[src]pub fn new() -> Commands[src]Creates and returns a new instance.
+pub fn return_after_usage(&mut self, command: Box<dyn Command>)[src]Returns the command after it was being used. +No validations will be made.
+pub fn set(&mut self, command: Box<dyn Command>) -> Result<(), ScriptError>[src]Adds a new command definition. +It will fail in case another command already defined the same name/aliases
+pub fn get(&self, name: &str) -> Option<&Box<dyn Command>>[src]Return the command based on the given command name/alias
+pub fn exists(&self, name: &str) -> bool[src]Return true if the command based on the given command name/alias exists
+pub fn get_for_use(&mut self, name: &str) -> Option<Box<dyn Command>>[src]Return the command based on the given command name/alias. +It will also remove it in the process.
+pub fn get_all_command_names(&self) -> Vec<String>[src]Returns all the command names currently registered
+pub fn remove(&mut self, name: &str)[src]Removes the requested command.
+impl !Send for Commandsimpl Unpin for Commandsimpl !Sync for Commandsimpl !RefUnwindSafe for Commandsimpl !UnwindSafe for Commandsimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]Defines the command capabilities
+fn aliases(&self) -> Vec<String>A list of aliases that can also be used to invoke this command.
+fn help(&self) -> StringCommand documentation.
+fn requires_context(&self) -> boolIf true the run with the context will be invoked.
+fn run(&self, _arguments: Vec<String>) -> CommandResultRuns the given instruction
+fn run_with_context(
&self,
_arguments: Vec<String>,
_state: &mut HashMap<String, StateValue>,
_variables: &mut HashMap<String, String>,
_output_variable: Option<String>,
_instructions: &Vec<Instruction>,
_commands: &mut Commands,
_line: usize
) -> CommandResultRun the instruction with access to the runtime context.
+arguments - The command arguments arraystate - Internal state which is only used by commands to store/pull datavariables - All script variablesoutput_variable - The output variable name (if defined)instructions - The entire list of instructions which make up the currently running scriptcommands - The currently known commandsline - The current instruction line number (global line number after including all scripts into one global script)Holds the error information
+ErrorReadingFile(String, Option<Error>)Error Info Type
+Initialization(String)Error Info Type
+Runtime(String, Option<InstructionMetaInfo>)Error Info Type
+PreProcessNoCommandFound(InstructionMetaInfo)Error Info Type
+ControlWithoutValidValue(InstructionMetaInfo)Error Info Type
+InvalidControlLocation(InstructionMetaInfo)Error Info Type
+MissingEndQuotes(InstructionMetaInfo)Error Info Type
+MissingOutputVariableName(InstructionMetaInfo)Error Info Type
+InvalidEqualsLocation(InstructionMetaInfo)Error Info Type
+InvalidQuotesLocation(InstructionMetaInfo)Error Info Type
+EmptyLabel(InstructionMetaInfo)Error Info Type
+UnknownPreProcessorCommand(InstructionMetaInfo)Error Info Type
+impl Send for ErrorInfoimpl Unpin for ErrorInfoimpl Sync for ErrorInfoimpl !RefUnwindSafe for ErrorInfoimpl !UnwindSafe for ErrorInfoimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]The error structure and types.
+| ScriptError | Script error struct + |
| ErrorInfo | Holds the error information + |
Script error struct
+info: ErrorInfoHolds the error information
+impl Display for ScriptError[src]fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>[src]Formats the script error using the given formatter.
+impl Debug for ScriptError[src]impl Send for ScriptErrorimpl Unpin for ScriptErrorimpl Sync for ScriptErrorimpl !RefUnwindSafe for ScriptErrorimpl !UnwindSafe for ScriptErrorimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> ToString for T where
T: Display + ?Sized, [src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]All duckscript types.
+| command | command + |
| error | error + |
| instruction | instruction + |
| runtime | runtime + |
Instruction Type - script, preprocess
+EmptyEmpty instruction
+PreProcess(PreProcessInstruction)Preprocess instruction
+Script(ScriptInstruction)Runtime script instruction
+impl Clone for InstructionType[src]fn clone(&self) -> InstructionType[src]fn clone_from(&mut self, source: &Self)1.0.0[src]Performs copy-assignment from source. Read more
impl Debug for InstructionType[src]impl Send for InstructionTypeimpl Unpin for InstructionTypeimpl Sync for InstructionTypeimpl RefUnwindSafe for InstructionTypeimpl UnwindSafe for InstructionTypeimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+fn to_owned(&self) -> T[src]fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]The instruction type.
+| Instruction | Instruction data + |
| InstructionMetaInfo | Meta information for all instruction types + |
| PreProcessInstruction | Preprocess instruction + |
| ScriptInstruction | Runtime script instruction + |
| InstructionType | Instruction Type - script, preprocess + |
Instruction data
+meta_info: InstructionMetaInfoMeta info
+instruction_type: InstructionTypeThe instruction
+impl Clone for Instruction[src]fn clone(&self) -> Instruction[src]fn clone_from(&mut self, source: &Self)1.0.0[src]Performs copy-assignment from source. Read more
impl Debug for Instruction[src]impl Send for Instructionimpl Unpin for Instructionimpl Sync for Instructionimpl RefUnwindSafe for Instructionimpl UnwindSafe for Instructionimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+fn to_owned(&self) -> T[src]fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]Meta information for all instruction types
+line: Option<usize>The line number
+source: Option<String>The source file/url/...
+impl InstructionMetaInfo[src]pub fn new() -> InstructionMetaInfo[src]Creates and returns a new instance.
+impl Clone for InstructionMetaInfo[src]fn clone(&self) -> InstructionMetaInfo[src]fn clone_from(&mut self, source: &Self)1.0.0[src]Performs copy-assignment from source. Read more
impl Debug for InstructionMetaInfo[src]impl Send for InstructionMetaInfoimpl Unpin for InstructionMetaInfoimpl Sync for InstructionMetaInfoimpl RefUnwindSafe for InstructionMetaInfoimpl UnwindSafe for InstructionMetaInfoimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+fn to_owned(&self) -> T[src]fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]Preprocess instruction
+command: Option<String>The command name
+arguments: Option<Vec<String>>The command arguments
+impl PreProcessInstruction[src]pub fn new() -> PreProcessInstruction[src]Creates and returns a new instance.
+impl Clone for PreProcessInstruction[src]fn clone(&self) -> PreProcessInstruction[src]fn clone_from(&mut self, source: &Self)1.0.0[src]Performs copy-assignment from source. Read more
impl Debug for PreProcessInstruction[src]impl Send for PreProcessInstructionimpl Unpin for PreProcessInstructionimpl Sync for PreProcessInstructionimpl RefUnwindSafe for PreProcessInstructionimpl UnwindSafe for PreProcessInstructionimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+fn to_owned(&self) -> T[src]fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]Runtime script instruction
+label: Option<String>The label tag
+output: Option<String>The command output variable name
+command: Option<String>The command name
+arguments: Option<Vec<String>>The command arguments
+impl ScriptInstruction[src]pub fn new() -> ScriptInstruction[src]Creates and returns a new instance.
+impl Clone for ScriptInstruction[src]fn clone(&self) -> ScriptInstruction[src]fn clone_from(&mut self, source: &Self)1.0.0[src]Performs copy-assignment from source. Read more
impl Debug for ScriptInstruction[src]impl Send for ScriptInstructionimpl Unpin for ScriptInstructionimpl Sync for ScriptInstructionimpl RefUnwindSafe for ScriptInstructionimpl UnwindSafe for ScriptInstructionimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+fn to_owned(&self) -> T[src]fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]enum defining what values can be stored in the state map
+Boolean(bool)boolean value
+Number(isize)signed number
+UnsignedNumber(usize)unsigned number
+Number32Bit(i32)signed number
+UnsignedNumber32Bit(u32)unsigned number
+Number64Bit(i64)signed number
+UnsignedNumber64Bit(u64)unsigned number
+String(String)textual value
+List(Vec<StateValue>)list
+SubState(HashMap<String, StateValue>)sub state value
+impl Clone for StateValue[src]fn clone(&self) -> StateValue[src]fn clone_from(&mut self, source: &Self)1.0.0[src]Performs copy-assignment from source. Read more
impl Debug for StateValue[src]impl Send for StateValueimpl Unpin for StateValueimpl Sync for StateValueimpl RefUnwindSafe for StateValueimpl UnwindSafe for StateValueimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+fn to_owned(&self) -> T[src]fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]The runtime context structures.
+| Context | The context structure + |
| Runtime | The runtime structure + |
| StateValue | enum defining what values can be stored in the state map + |
The context structure
+variables: HashMap<String, String>The runtime variables
+state: HashMap<String, StateValue>The runtime state
+commands: CommandsThe command implementations
+impl Context[src]impl !Send for Contextimpl Unpin for Contextimpl !Sync for Contextimpl !RefUnwindSafe for Contextimpl !UnwindSafe for Contextimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]The runtime structure
+instructions: Option<Vec<Instruction>>The script instructions
+label_to_line: HashMap<String, usize>Label to line number mapping
+context: ContextThe runtime context
+impl Runtime[src]impl !Send for Runtimeimpl Unpin for Runtimeimpl !Sync for Runtimeimpl !RefUnwindSafe for Runtimeimpl !UnwindSafe for Runtimeimpl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]type Error = <U as TryFrom<T>>::ErrorThe type returned in the event of a conversion error.
+fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]fn borrow_mut(&mut self) -> &mut T[src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> Any for T where
T: 'static + ?Sized, [src]| "+""+(item.is_alias===true?(""+item.alias+" - see "):"")+item.displayPath+""+name+" | "+""+""+escape(item.desc)+" |
"+code.outerHTML+" |
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +
+//! # expansion +//! +//! The expand utility functions. +//! + +#[cfg(test)] +#[path = "./expansion_test.rs"] +mod expansion_test; + +use crate::parser; +use crate::types::instruction::InstructionMetaInfo; +use std::collections::HashMap; + +pub(crate) enum ExpandedValue { + Single(String), + Multi(Vec<String>), + None, +} + +fn should_break_key(value: char) -> bool { + value == ' ' || value == '\n' || value == '\t' || value == '\r' || value == '=' +} + +fn push_prefix(buffer: &mut String, single_type: bool, found_prefix_fully: bool) { + if single_type { + buffer.push('$'); + } else { + buffer.push('%'); + } + + if found_prefix_fully { + buffer.push('{'); + } +} + +pub(crate) fn expand_by_wrapper( + value: &str, + meta_info: &InstructionMetaInfo, + variables: &HashMap<String, String>, +) -> ExpandedValue { + let mut value_string = String::new(); + + let mut prefix_index = 0; + let mut found_prefix = false; + let mut key = String::new(); + let mut force_push = false; + let mut single_type = true; + for next_char in value.chars() { + if !found_prefix { + if next_char == '\\' && prefix_index == 0 { + // skip this character + force_push = true + } else if force_push { + value_string.push(next_char); + force_push = false; + } else if prefix_index == 0 && (next_char == '$' || next_char == '%') { + prefix_index = 1; + + single_type = if next_char == '$' { true } else { false }; + } else if prefix_index == 1 && next_char == '{' { + found_prefix = true; + prefix_index = 0; + key.clear(); + } else { + if prefix_index > 0 || found_prefix { + push_prefix(&mut value_string, single_type, found_prefix); + prefix_index = 0; + } + value_string.push(next_char); + } + } else if next_char == '}' { + match variables.get(&key) { + Some(variable_value) => value_string.push_str(&variable_value), + _ => (), + }; + + key.clear(); + found_prefix = false; + } else if should_break_key(next_char) { + if prefix_index > 0 || found_prefix { + push_prefix(&mut value_string, single_type, found_prefix); + prefix_index = 0; + } + value_string.push_str(&key); + value_string.push(next_char); + + key.clear(); + found_prefix = false; + } else { + key.push(next_char); + } + } + + if key.len() > 0 { + if prefix_index > 0 || found_prefix { + push_prefix(&mut value_string, single_type, found_prefix); + } + value_string.push_str(&key); + } + + if value_string.is_empty() { + ExpandedValue::None + } else if single_type { + ExpandedValue::Single(value_string.to_string()) + } else { + let chars = value_string.to_string().chars().collect(); + match parser::parse_arguments(meta_info, &chars, 0) { + Ok(values_option) => match values_option { + Some(values) => ExpandedValue::Multi(values), + None => ExpandedValue::None, + }, + Err(_) => ExpandedValue::None, + } + } +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +
+//! # io +//! +//! IO helper functions +//! + +#[cfg(test)] +#[path = "./io_test.rs"] +mod io_test; + +use crate::types::error::{ErrorInfo, ScriptError}; +use std::fs::File; +use std::io::Read; +use std::path::Path; + +pub(crate) fn read_text_file(file: &str) -> Result<String, ScriptError> { + let file_path = Path::new(file); + + match File::open(&file_path) { + Ok(mut fd) => { + let mut content = String::new(); + fd.read_to_string(&mut content).unwrap(); + + Ok(content) + } + Err(error) => Err(ScriptError { + info: ErrorInfo::ErrorReadingFile(file.to_string(), Some(error)), + }), + } +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +
+#![deny( + absolute_paths_not_starting_with_crate, + ambiguous_associated_items, + anonymous_parameters, + const_err, + dead_code, + deprecated, + deprecated_in_future, + duplicate_macro_exports, + ellipsis_inclusive_range_patterns, + exceeding_bitshifts, + explicit_outlives_requirements, + exported_private_dependencies, + ill_formed_attribute_input, + illegal_floating_point_literal_pattern, + improper_ctypes, + indirect_structural_match, + invalid_type_param_default, + irrefutable_let_patterns, + keyword_idents, + late_bound_lifetime_arguments, + legacy_constructor_visibility, + legacy_directory_ownership, + macro_expanded_macro_exports_accessed_by_absolute_paths, + missing_copy_implementations, + missing_docs, + missing_fragment_specifier, + mutable_borrow_reservation_conflict, + mutable_transmutes, + nested_impl_trait, + no_mangle_const_items, + no_mangle_generic_items, + non_ascii_idents, + non_camel_case_types, + non_shorthand_field_patterns, + non_snake_case, + non_upper_case_globals, + order_dependent_trait_objects, + overflowing_literals, + parenthesized_params_in_types_and_modules, + path_statements, + patterns_in_fns_without_body, + plugin_as_library, + private_doc_tests, + private_in_public, + proc_macro_derive_resolution_fallback, + pub_use_of_private_extern_crate, + safe_extern_statics, + safe_packed_borrows, + stable_features, + trivial_bounds, + trivial_casts, + trivial_numeric_casts, + type_alias_bounds, + tyvar_behind_raw_pointer, + unconditional_recursion, + unions_with_drop_fields, + unknown_crate_types, + unnameable_test_items, + unreachable_code, + unreachable_patterns, + unreachable_pub, + unsafe_code, + unstable_features, + unstable_name_collisions, + unused_allocation, + unused_assignments, + unused_attributes, + unused_comparisons, + unused_doc_comments, + unused_extern_crates, + unused_features, + unused_import_braces, + unused_imports, + unused_labels, + unused_lifetimes, + unused_macros, + unused_must_use, + unused_mut, + unused_parens, + unused_qualifications, + unused_unsafe, + unused_variables, + where_clauses_object_safety, + while_true +)] +#![warn(macro_use_extern_crate, unknown_lints)] +#![allow( + bare_trait_objects, + box_pointers, + elided_lifetimes_in_paths, + intra_doc_link_resolution_failure, + missing_doc_code_examples, + missing_debug_implementations, + single_use_lifetimes, + unused_results, + variant_size_differences, + warnings, + renamed_and_removed_lints +)] + +//! # duckscript +//! +//! Simple, extendable and embeddable scripting language. +//! +//! This library is the actual script parser and runner.<br> +//! On it's own, it has no actual commands as those need to be provided externally (see duckscript_sdk). +//! +//! # Installation +//! In order to use this library, just add it as a dependency: +//! +//! ```ini +//! [dependencies] +//! duckscript = "*" +//! ``` +//! +//! # Contributing +//! See [contributing guide](https://github.com/sagiegurari/duckscript/blob/master/.github/CONTRIBUTING.md) +//! +//! # License +//! Developed by Sagie Gur-Ari and licensed under the +//! [Apache 2](https://github.com/sagiegurari/duckscript/blob/master/LICENSE) open source license. +//! + +mod expansion; +mod io; +pub mod parser; +mod preprocessor; +pub mod runner; +pub mod types; + +#[cfg(test)] +mod test; +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287 +288 +289 +290 +291 +292 +293 +294 +295 +296 +297 +298 +299 +300 +301 +302 +303 +304 +305 +306 +307 +308 +309 +310 +311 +312 +313 +314 +315 +316 +317 +318 +319 +320 +321 +322 +323 +324 +325 +326 +327 +328 +329 +330 +331 +332 +333 +334 +335 +336 +337 +338 +339 +340 +341 +342 +343 +344 +345 +346 +347 +348 +349 +350 +351 +352 +353 +354 +355 +356 +357 +358 +359 +360 +361 +362 +363 +364 +365 +366 +367 +368 +369 +370 +371 +372 +373 +374 +375 +376 +377 +378 +379 +380 +381 +382 +383 +384 +385 +386 +387 +388 +389 +390 +391 +392 +393 +394 +395 +396 +397 +398 +399 +400 +401 +402 +403 +404 +405 +406 +407 +408 +409 +410 +411 +412 +413 +414 +415 +416 +417 +418 +419 +420 +421 +422 +423 +424 +425 +426 +427 +428 +429 +430 +431 +432 +433 +434 +435 +436 +437 +438 +439 +440 +441 +442 +443 +444 +445 +446 +447 +448 +449 +450 +451 +452 +453 +454 +455 +456 +457 +458 +459 +460 +461 +462 +463 +464 +465 +466 +467 +
+//! # parser +//! +//! The duck script parser. +//! + +#[cfg(test)] +#[path = "./parser_test.rs"] +mod parser_test; + +use crate::io; +use crate::preprocessor; +use crate::types::error::{ErrorInfo, ScriptError}; +use crate::types::instruction::{ + Instruction, InstructionMetaInfo, InstructionType, PreProcessInstruction, ScriptInstruction, +}; + +static COMMENT_PREFIX_STR: &str = "#"; +static PRE_PROCESS_PREFIX: char = '!'; +static LABEL_PREFIX: char = ':'; + +/// parses the file and returns a vector of instructions +pub fn parse_file(file: &str) -> Result<Vec<Instruction>, ScriptError> { + let mut meta_info = InstructionMetaInfo::new(); + meta_info.source = Some(file.to_string()); + + match io::read_text_file(file) { + Ok(text) => parse_lines(&text, meta_info), + Err(error) => Err(error), + } +} + +/// parses the provided script text and returns a vector of instructions +pub fn parse_text(text: &str) -> Result<Vec<Instruction>, ScriptError> { + parse_lines(&text, InstructionMetaInfo::new()) +} + +fn parse_lines( + lines: &str, + meta_info: InstructionMetaInfo, +) -> Result<Vec<Instruction>, ScriptError> { + let mut instructions = vec![]; + + let mut line_number = 1; + for line in lines.lines() { + let mut line_meta_info = meta_info.clone(); + line_meta_info.line = Some(line_number); + line_number = line_number + 1; + + match parse_line(&line, line_meta_info) { + Ok(instruction) => { + instructions.push(instruction.clone()); + + match instruction.instruction_type { + InstructionType::PreProcess(_) => match preprocessor::run(&instruction) { + Ok(mut added_instructions) => instructions.append(&mut added_instructions), + Err(error) => return Err(error), + }, + _ => (), + } + } + Err(error) => return Err(error), + }; + } + + Ok(instructions) +} + +fn parse_line(line_text: &str, meta_info: InstructionMetaInfo) -> Result<Instruction, ScriptError> { + let trimmed_text = line_text.trim(); + + if trimmed_text.is_empty() || trimmed_text.starts_with(&COMMENT_PREFIX_STR) { + Ok(Instruction { + meta_info, + instruction_type: InstructionType::Empty, + }) + } else { + let chars: Vec<char> = trimmed_text.chars().collect(); + + if chars[0] == PRE_PROCESS_PREFIX { + parse_pre_process_line(&chars, meta_info, 1) + } else { + parse_command_line(&chars, meta_info, 0) + } + } +} + +fn parse_pre_process_line( + line_text: &Vec<char>, + meta_info: InstructionMetaInfo, + start_index: usize, +) -> Result<Instruction, ScriptError> { + if line_text.is_empty() { + Err(ScriptError { + info: ErrorInfo::PreProcessNoCommandFound(meta_info), + }) + } else { + let mut command = String::new(); + let mut index = start_index; + let end_index = line_text.len(); + for _i in index..end_index { + let character = line_text[index]; + index = index + 1; + + if character == ' ' { + if !command.is_empty() { + break; + } + } else { + command.push(character); + } + } + + if command.is_empty() { + Err(ScriptError { + info: ErrorInfo::PreProcessNoCommandFound(meta_info), + }) + } else { + match parse_arguments(&meta_info, &line_text, index) { + Ok(arguments) => { + let mut instruction = PreProcessInstruction::new(); + instruction.command = Some(command); + instruction.arguments = arguments; + + Ok(Instruction { + meta_info, + instruction_type: InstructionType::PreProcess(instruction), + }) + } + Err(error) => Err(error), + } + } + } +} + +fn parse_command_line( + line_text: &Vec<char>, + meta_info: InstructionMetaInfo, + start_index: usize, +) -> Result<Instruction, ScriptError> { + let end_index = line_text.len(); + + if line_text.is_empty() || start_index >= end_index { + Ok(Instruction { + meta_info, + instruction_type: InstructionType::Empty, + }) + } else { + // search for label + let mut index = start_index; + let mut instruction = ScriptInstruction::new(); + match find_label(&meta_info, &line_text, index) { + Ok(output) => { + let (next_index, value) = output; + index = next_index; + + if value.is_some() { + instruction.label = value.clone(); + } + } + Err(error) => return Err(error), + }; + + // find output variable and command + index = match find_output_and_command(&meta_info, &line_text, index, &mut instruction) { + Ok(next_index) => next_index, + Err(error) => return Err(error), + }; + + match parse_arguments(&meta_info, &line_text, index) { + Ok(arguments) => { + instruction.arguments = arguments; + + let instruction_type = if instruction.label.is_none() + && instruction.output.is_none() + && instruction.command.is_none() + { + InstructionType::Empty + } else { + InstructionType::Script(instruction) + }; + + Ok(Instruction { + meta_info, + instruction_type, + }) + } + Err(error) => Err(error), + } + } +} + +pub(crate) fn parse_arguments( + meta_info: &InstructionMetaInfo, + line_text: &Vec<char>, + start_index: usize, +) -> Result<Option<Vec<String>>, ScriptError> { + let mut arguments = vec![]; + + let mut index = start_index; + loop { + match parse_next_argument(&meta_info, &line_text, index) { + Ok(output) => { + let (next_index, argument) = output; + + if argument.is_none() { + break; + } + + arguments.push(argument.unwrap()); + index = next_index; + } + Err(error) => return Err(error), + } + } + + if arguments.is_empty() { + Ok(None) + } else { + Ok(Some(arguments)) + } +} + +fn parse_next_argument( + meta_info: &InstructionMetaInfo, + line_text: &Vec<char>, + start_index: usize, +) -> Result<(usize, Option<String>), ScriptError> { + parse_next_value(&meta_info, &line_text, start_index, true, true, false) +} + +fn parse_next_value( + meta_info: &InstructionMetaInfo, + line_text: &Vec<char>, + start_index: usize, + allow_quotes: bool, + allow_control: bool, + stop_on_equals: bool, +) -> Result<(usize, Option<String>), ScriptError> { + let end_index = line_text.len(); + + if start_index >= end_index { + Ok((start_index, None)) + } else { + let mut argument = String::new(); + let mut index = start_index; + let mut in_argument = false; + let mut using_quotes = false; + let mut in_control = false; + let mut found_end = false; + let mut found_variable_prefix = false; + for _i in index..end_index { + let character = line_text[index]; + index = index + 1; + + if in_argument { + if in_control { + if found_variable_prefix { + if character == '{' { + argument.push_str("\\${"); + in_control = false; + found_variable_prefix = false; + } else { + return Err(ScriptError { + info: ErrorInfo::ControlWithoutValidValue(meta_info.clone()), + }); + } + } else if character == '\\' || character == '"' { + argument.push(character); + in_control = false; + } else if character == 'n' { + argument.push('\n'); + in_control = false; + } else if character == 'r' { + argument.push('\r'); + in_control = false; + } else if character == 't' { + argument.push('\t'); + in_control = false; + } else if character == '$' { + found_variable_prefix = true; + } else { + return Err(ScriptError { + info: ErrorInfo::ControlWithoutValidValue(meta_info.clone()), + }); + } + } else if character == '\\' { + if allow_control { + in_control = true; + found_variable_prefix = false; + } else { + return Err(ScriptError { + info: ErrorInfo::InvalidControlLocation(meta_info.clone()), + }); + } + } else if using_quotes && character == '"' { + found_end = true; + break; + } else if !using_quotes + && (character == ' ' + || character == '#' + || (stop_on_equals && character == '=')) + { + if character == ' ' || character == '=' { + index = index - 1; + } else if character == '#' { + index = end_index; + } + found_end = true; + break; + } else { + argument.push(character); + } + } else if character == '#' { + index = end_index; + break; + } else if character != ' ' { + in_argument = true; + + if character == '"' { + if allow_quotes { + using_quotes = true; + } else { + return Err(ScriptError { + info: ErrorInfo::InvalidQuotesLocation(meta_info.clone()), + }); + } + } else if character == '\\' { + if allow_control { + in_control = true; + } else { + return Err(ScriptError { + info: ErrorInfo::InvalidControlLocation(meta_info.clone()), + }); + } + } else { + argument.push(character); + } + } + } + + if in_argument && !found_end && (in_control || using_quotes) { + if in_control { + Err(ScriptError { + info: ErrorInfo::ControlWithoutValidValue(meta_info.clone()), + }) + } else { + Err(ScriptError { + info: ErrorInfo::MissingEndQuotes(meta_info.clone()), + }) + } + } else if argument.is_empty() { + if using_quotes { + Ok((index, Some(argument))) + } else { + Ok((index, None)) + } + } else { + Ok((index, Some(argument))) + } + } +} + +fn find_label( + meta_info: &InstructionMetaInfo, + line_text: &Vec<char>, + start_index: usize, +) -> Result<(usize, Option<String>), ScriptError> { + let end_index = line_text.len(); + + if start_index >= end_index { + Ok((start_index, None)) + } else { + let mut label = None; + let mut index = start_index; + for _i in index..end_index { + let character = line_text[index]; + index = index + 1; + + if character == LABEL_PREFIX { + match parse_next_value(&meta_info, &line_text, index, false, false, false) { + Ok(output) => { + let (next_index, value) = output; + index = next_index; + + match value { + Some(label_value) => { + if label_value.is_empty() { + return Err(ScriptError { + info: ErrorInfo::EmptyLabel(meta_info.clone()), + }); + } + + let mut text = String::new(); + text.push(LABEL_PREFIX); + text.push_str(&label_value); + + label = Some(text); + } + None => (), + }; + + break; + } + Err(error) => return Err(error), + }; + } else if character != ' ' { + index = index - 1; + break; + } + } + + Ok((index, label)) + } +} + +fn find_output_and_command( + meta_info: &InstructionMetaInfo, + line_text: &Vec<char>, + start_index: usize, + instruction: &mut ScriptInstruction, +) -> Result<usize, ScriptError> { + match parse_next_value(&meta_info, &line_text, start_index, false, false, true) { + Ok(output) => { + let (next_index, value) = output; + + if value.is_none() { + Ok(next_index) + } else { + let mut index = next_index; + let end_index = line_text.len(); + for _i in index..end_index { + let character = line_text[index]; + index = index + 1; + + if character != ' ' { + if character == '=' { + instruction.output = value.clone(); + } + + break; + } + } + + if instruction.output.is_some() { + match parse_next_value(&meta_info, &line_text, index, false, false, false) { + Ok(output) => { + let (next_index, value) = output; + + if value.is_none() { + Ok(index) + } else { + instruction.command = value.clone(); + Ok(next_index) + } + } + Err(error) => Err(error), + } + } else { + instruction.command = value.clone(); + + Ok(next_index) + } + } + } + Err(error) => Err(error), + } +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +
+//! # include_files_preprocessor +//! +//! Enables to load and include additional source files. +//! + +use crate::parser; +use crate::types::error::ScriptError; +use crate::types::instruction::{Instruction, InstructionMetaInfo}; +use std::path::PathBuf; + +pub(crate) fn run( + arguments: &Option<Vec<String>>, + meta_info: &InstructionMetaInfo, +) -> Result<Vec<Instruction>, ScriptError> { + let mut instructions = vec![]; + + if let Some(arguments_vec) = arguments { + for argument in arguments_vec { + // get file based on parent file location + let file_path = if argument.starts_with("/") || argument.starts_with("\\") { + argument.to_string() + } else { + match &meta_info.source { + Some(value) => { + let path_buffer = PathBuf::from(&value); + match path_buffer.parent() { + Some(path) => { + let mut parent_path_buffer = path.to_path_buf(); + parent_path_buffer.push(&argument); + + let full_path_buffer = match parent_path_buffer.canonicalize() { + Ok(new_buffer) => new_buffer, + _ => parent_path_buffer, + }; + + full_path_buffer.to_string_lossy().into_owned() + } + _ => argument.to_string(), + } + } + None => argument.to_string(), + } + }; + + match parser::parse_file(&file_path) { + Ok(mut additional_instructions) => { + instructions.append(&mut additional_instructions) + } + Err(error) => return Err(error), + } + } + } + + Ok(instructions) +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +
+//! # preprocessor +//! +//! The pre processor is invoked on parse time by the script parser. +//! Currently it provide only limited amount of commands and it is not meant to be extendable. +//! + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +mod include_files_preprocessor; +mod print_preprocessor; + +use crate::types::error::{ErrorInfo, ScriptError}; +use crate::types::instruction::{Instruction, InstructionType}; + +pub(crate) fn run(instruction: &Instruction) -> Result<Vec<Instruction>, ScriptError> { + match instruction.instruction_type { + InstructionType::PreProcess(ref instruction_type) => match &instruction_type.command { + Some(command) => match command.as_ref() { + "print" => { + print_preprocessor::run(&instruction_type.arguments); + Ok(vec![]) + } + "include_files" => include_files_preprocessor::run( + &instruction_type.arguments, + &instruction.meta_info, + ), + _ => Err(ScriptError { + info: ErrorInfo::UnknownPreProcessorCommand(instruction.meta_info.clone()), + }), + }, + None => Err(ScriptError { + info: ErrorInfo::PreProcessNoCommandFound(instruction.meta_info.clone()), + }), + }, + _ => Ok(vec![]), + } +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +
+//! # print_preprocessor +//! +//! The print pre processor implementation. +//! + +pub(crate) fn run(arguments: &Option<Vec<String>>) { + if let Some(arguments_vec) = arguments { + for argument in arguments_vec { + print!("{} ", argument); + } + } + + println!(""); +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287 +288 +289 +290 +291 +292 +293 +294 +
+//! # runner +//! +//! The main entry point which enables running scripts. +//! + +#[cfg(test)] +#[path = "./runner_test.rs"] +mod runner_test; + +use crate::expansion::{self, ExpandedValue}; +use crate::parser; +use crate::types::command::{CommandResult, Commands, GoToValue}; +use crate::types::error::{ErrorInfo, ScriptError}; +use crate::types::instruction::{ + Instruction, InstructionMetaInfo, InstructionType, ScriptInstruction, +}; +use crate::types::runtime::{Context, Runtime, StateValue}; +use std::collections::HashMap; + +/// Executes the provided script with the given context +pub fn run_script(text: &str, context: Context) -> Result<Context, ScriptError> { + match parser::parse_text(text) { + Ok(instructions) => run(instructions, context), + Err(error) => Err(error), + } +} + +/// Executes the provided script file with the given context +pub fn run_script_file(file: &str, context: Context) -> Result<Context, ScriptError> { + match parser::parse_file(file) { + Ok(instructions) => run(instructions, context), + Err(error) => Err(error), + } +} + +fn run(instructions: Vec<Instruction>, context: Context) -> Result<Context, ScriptError> { + let runtime = create_runtime(instructions, context); + + run_instructions(runtime, 0) +} + +fn create_runtime(instructions: Vec<Instruction>, context: Context) -> Runtime { + let mut runtime = Runtime::new(context); + + let mut line = 0; + for instruction in &instructions { + match &instruction.instruction_type { + InstructionType::Script(ref value) => { + match value.label { + Some(ref label) => { + runtime.label_to_line.insert(label.to_string(), line); + () + } + None => (), + }; + } + _ => (), + }; + + line = line + 1; + } + + runtime.instructions = Some(instructions); + + runtime +} + +fn run_instructions(mut runtime: Runtime, start_at: usize) -> Result<Context, ScriptError> { + let mut line = start_at; + let mut state = runtime.context.state.clone(); + + let instructions = match runtime.instructions { + Some(ref instructions) => instructions, + None => return Ok(runtime.context), + }; + + loop { + let (instruction, meta_info) = if instructions.len() > line { + let instruction = instructions[line].clone(); + let meta_info = instruction.meta_info.clone(); + (instruction, meta_info) + } else { + break; + }; + + let (command_result, output_variable) = run_instruction( + &mut runtime.context.commands, + &mut runtime.context.variables, + &mut state, + &instructions, + instruction, + line, + ); + + match command_result { + CommandResult::Exit(output) => { + update_output(&mut runtime.context.variables, output_variable, output); + + break; + } + CommandResult::Error(error) => { + update_output( + &mut runtime.context.variables, + output_variable, + Some("false".to_string()), + ); + + let post_error_line = line + 1; + + let should_continue = run_on_error_instruction( + &mut runtime.context.commands, + &mut runtime.context.variables, + &mut state, + &instructions, + error, + meta_info, + ); + + if !should_continue { + break; + } + + line = post_error_line; + + () + } + CommandResult::Crash(error) => { + return Err(ScriptError { + info: ErrorInfo::Runtime(error, Some(meta_info)), + }); + } + CommandResult::Continue(output) => { + update_output(&mut runtime.context.variables, output_variable, output); + + line = line + 1; + + () + } + CommandResult::GoTo(output, goto_value) => { + update_output(&mut runtime.context.variables, output_variable, output); + + match goto_value { + GoToValue::Label(label) => match runtime.label_to_line.get(&label) { + Some(value) => line = *value, + None => { + return Err(ScriptError { + info: ErrorInfo::Runtime( + format!("Label: {} not found.", label), + Some(meta_info), + ), + }); + } + }, + GoToValue::Line(line_number) => line = line_number, + } + } + }; + } + + runtime.context.state = state; + + Ok(runtime.context) +} + +fn update_output( + variables: &mut HashMap<String, String>, + output_variable: Option<String>, + output: Option<String>, +) { + if output_variable.is_some() { + match output { + Some(value) => variables.insert(output_variable.unwrap(), value), + None => variables.remove(&output_variable.unwrap()), + }; + } +} + +fn run_on_error_instruction( + commands: &mut Commands, + variables: &mut HashMap<String, String>, + state: &mut HashMap<String, StateValue>, + instructions: &Vec<Instruction>, + error: String, + meta_info: InstructionMetaInfo, +) -> bool { + if commands.exists("on_error") { + let mut script_instruction = ScriptInstruction::new(); + script_instruction.command = Some("on_error".to_string()); + script_instruction.arguments = Some(vec![ + error, + meta_info.line.unwrap_or(0).to_string(), + meta_info.source.unwrap_or("".to_string()), + ]); + let instruction = Instruction { + meta_info: InstructionMetaInfo::new(), + instruction_type: InstructionType::Script(script_instruction), + }; + + let (command_result, output_variable) = + run_instruction(commands, variables, state, instructions, instruction, 0); + + match command_result { + CommandResult::Exit(output) => { + update_output(variables, output_variable, output); + + false + } + CommandResult::Crash(_) => false, + _ => true, + } + } else { + true + } +} + +/// Enables to evaluate a single instruction and return its result. +pub fn run_instruction( + commands: &mut Commands, + variables: &mut HashMap<String, String>, + state: &mut HashMap<String, StateValue>, + instructions: &Vec<Instruction>, + instruction: Instruction, + line: usize, +) -> (CommandResult, Option<String>) { + let mut output_variable = None; + let command_result = match instruction.instruction_type { + InstructionType::Empty => CommandResult::Continue(None), + InstructionType::PreProcess(_) => CommandResult::Continue(None), + InstructionType::Script(ref script_instruction) => { + output_variable = script_instruction.output.clone(); + + match script_instruction.command { + Some(ref command) => match commands.get_for_use(command) { + Some(command_instance) => { + let command_arguments = bind_command_arguments( + &variables, + &script_instruction, + &instruction.meta_info, + ); + + let command_result = if command_instance.requires_context() { + command_instance.run_with_context( + command_arguments, + state, + variables, + output_variable.clone(), + &instructions, + commands, + line, + ) + } else { + command_instance.run(command_arguments) + }; + + commands.return_after_usage(command_instance); + + command_result + } + None => CommandResult::Error(format!("Command: {} not found.", &command)), + }, + None => CommandResult::Continue(None), + } + } + }; + + (command_result, output_variable) +} + +fn bind_command_arguments( + variables: &HashMap<String, String>, + instruction: &ScriptInstruction, + meta_info: &InstructionMetaInfo, +) -> Vec<String> { + let mut arguments = vec![]; + + match instruction.arguments { + Some(ref arguments_ref) => { + for argument in arguments_ref { + match expansion::expand_by_wrapper(&argument, meta_info, variables) { + ExpandedValue::Single(value) => arguments.push(value), + ExpandedValue::Multi(values) => { + for value in values { + arguments.push(value) + } + } + ExpandedValue::None => arguments.push("".to_string()), + } + } + } + None => (), + }; + + arguments +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +
+//! # command +//! +//! The command trait and access module. +//! + +#[cfg(test)] +#[path = "./command_test.rs"] +mod command_test; + +use crate::types::error::{ErrorInfo, ScriptError}; +use crate::types::instruction::Instruction; +use crate::types::runtime::StateValue; +use std::collections::HashMap; + +/// GoTo type value +#[derive(Debug, Clone)] +pub enum GoToValue { + /// label target + Label(String), + /// Line number + Line(usize), +} + +/// Command execution result +#[derive(Debug, Clone)] +pub enum CommandResult { + /// Holds the command output and tells the runner to continue to next instruction + Continue(Option<String>), + /// Holds the command output and tells the runner to jump to the provided label + GoTo(Option<String>, GoToValue), + /// Holds the error message and the meta info of the instruction that caused it + Error(String), + /// Holds the critical error message and the meta info of the instruction that caused it + Crash(String), + /// Holds the command output and tells the runner to stop the script execution + Exit(Option<String>), +} + +/// Defines the command capabilities +pub trait Command { + /// The full command name which can be used to invoke this command. + fn name(&self) -> String; + + /// A list of aliases that can also be used to invoke this command. + fn aliases(&self) -> Vec<String> { + vec![] + } + + /// Command documentation. + fn help(&self) -> String { + format!("No documentation found for command: {}", self.name()) + } + + /// If true the run with the context will be invoked. + fn requires_context(&self) -> bool { + false + } + + /// Runs the given instruction + fn run(&self, _arguments: Vec<String>) -> CommandResult { + CommandResult::Error(format!("Not implemented for command: {}", &self.name()).to_string()) + } + + /// Run the instruction with access to the runtime context. + /// + /// # Arguments + /// + /// * `arguments` - The command arguments array + /// * `state` - Internal state which is only used by commands to store/pull data + /// * `variables` - All script variables + /// * `output_variable` - The output variable name (if defined) + /// * `instructions` - The entire list of instructions which make up the currently running script + /// * `commands` - The currently known commands + /// * `line` - The current instruction line number (global line number after including all scripts into one global script) + fn run_with_context( + &self, + _arguments: Vec<String>, + _state: &mut HashMap<String, StateValue>, + _variables: &mut HashMap<String, String>, + _output_variable: Option<String>, + _instructions: &Vec<Instruction>, + _commands: &mut Commands, + _line: usize, + ) -> CommandResult { + CommandResult::Error(format!("Not implemented for command: {}", &self.name()).to_string()) + } +} + +/// Holds and enables access to the runtime commands implementations +pub struct Commands { + /// mapping between command names to implementations + pub commands: HashMap<String, Box<dyn Command>>, + /// mapping between aliases to command names + pub aliases: HashMap<String, String>, +} + +impl Commands { + /// Creates and returns a new instance. + pub fn new() -> Commands { + Commands { + commands: HashMap::new(), + aliases: HashMap::new(), + } + } + + /// Returns the command after it was being used. + /// No validations will be made. + pub fn return_after_usage(&mut self, command: Box<dyn Command>) { + let name = command.name(); + + self.commands.insert(name.clone(), command); + } + + /// Adds a new command definition. + /// It will fail in case another command already defined the same name/aliases + pub fn set(&mut self, command: Box<dyn Command>) -> Result<(), ScriptError> { + let name = command.name(); + let aliases = command.aliases(); + + if self.commands.contains_key(&name) { + return Err(ScriptError { + info: ErrorInfo::Initialization(format!("Command: {} already defined.", &name)), + }); + } + + for alias in &aliases { + if self.aliases.contains_key(alias) { + return Err(ScriptError { + info: ErrorInfo::Initialization(format!( + "Alias: {} for command: {} already defined.", + &alias, &name + )), + }); + } + } + + self.commands.insert(name.clone(), command); + + for alias in &aliases { + self.aliases.insert(alias.to_string(), name.clone()); + } + + Ok(()) + } + + /// Return the command based on the given command name/alias + pub fn get(&self, name: &str) -> Option<&Box<dyn Command>> { + let command_name = match self.aliases.get(name) { + Some(ref value) => value, + None => name, + }; + + match self.commands.get(command_name) { + Some(ref value) => Some(value.clone()), + None => None, + } + } + + /// Return true if the command based on the given command name/alias exists + pub fn exists(&self, name: &str) -> bool { + let command = self.get(name); + + command.is_some() + } + + /// Return the command based on the given command name/alias. + /// It will also remove it in the process. + pub fn get_for_use(&mut self, name: &str) -> Option<Box<dyn Command>> { + let command_name = match self.aliases.get(name) { + Some(ref value) => value, + None => name, + }; + + match self.commands.remove(command_name) { + Some(value) => Some(value), + None => None, + } + } + + /// Returns all the command names currently registered + pub fn get_all_command_names(&self) -> Vec<String> { + let mut names = vec![]; + + for key in self.commands.keys() { + names.push(key.to_string()); + } + + names.sort(); + + names + } + + /// Removes the requested command. + pub fn remove(&mut self, name: &str) { + self.get_for_use(name); + } +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +
+//! # error +//! +//! The error structure and types. +//! + +use crate::types::instruction::InstructionMetaInfo; +use std::fmt; +use std::fmt::Display; +use std::io; + +#[cfg(test)] +#[path = "./error_test.rs"] +mod error_test; + +fn format_error_message( + formatter: &mut fmt::Formatter, + meta_info: &InstructionMetaInfo, + message: &str, +) -> Result<(), fmt::Error> { + let source = match meta_info.source { + Some(ref value) => value.to_string(), + None => "Unknown".to_string(), + }; + let line = match meta_info.line { + Some(value) => value.to_string(), + None => "Unknown".to_string(), + }; + + write!(formatter, "Source: {} Line: {} - {}", source, line, message) +} + +#[derive(Debug)] +/// Holds the error information +pub enum ErrorInfo { + /// Error Info Type + ErrorReadingFile(String, Option<io::Error>), + /// Error Info Type + Initialization(String), + /// Error Info Type + Runtime(String, Option<InstructionMetaInfo>), + /// Error Info Type + PreProcessNoCommandFound(InstructionMetaInfo), + /// Error Info Type + ControlWithoutValidValue(InstructionMetaInfo), + /// Error Info Type + InvalidControlLocation(InstructionMetaInfo), + /// Error Info Type + MissingEndQuotes(InstructionMetaInfo), + /// Error Info Type + MissingOutputVariableName(InstructionMetaInfo), + /// Error Info Type + InvalidEqualsLocation(InstructionMetaInfo), + /// Error Info Type + InvalidQuotesLocation(InstructionMetaInfo), + /// Error Info Type + EmptyLabel(InstructionMetaInfo), + /// Error Info Type + UnknownPreProcessorCommand(InstructionMetaInfo), +} + +#[derive(Debug)] +/// Script error struct +pub struct ScriptError { + /// Holds the error information + pub info: ErrorInfo, +} + +impl Display for ScriptError { + /// Formats the script error using the given formatter. + fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> { + match self.info { + ErrorInfo::ErrorReadingFile(ref file, ref cause) => { + writeln!(formatter, "Error reading file: {}", file)?; + match cause { + Some(cause_err) => cause_err.fmt(formatter), + None => Ok(()), + } + } + ErrorInfo::Initialization(ref message) => write!(formatter, "{}", message), + ErrorInfo::Runtime(ref message, ref meta_info) => { + let empty_meta_data = InstructionMetaInfo::new(); + let meta_info_value = meta_info.as_ref().unwrap_or(&empty_meta_data); + format_error_message(formatter, &meta_info_value, message) + } + ErrorInfo::PreProcessNoCommandFound(ref meta_info) => { + format_error_message(formatter, &meta_info, "preprocessor is missing a command") + } + ErrorInfo::ControlWithoutValidValue(ref meta_info) => format_error_message( + formatter, + &meta_info, + "control character found without a valid value", + ), + ErrorInfo::InvalidControlLocation(ref meta_info) => { + format_error_message(formatter, &meta_info, "invalid control character location") + } + ErrorInfo::MissingEndQuotes(ref meta_info) => { + format_error_message(formatter, &meta_info, "missing end quotes") + } + ErrorInfo::MissingOutputVariableName(ref meta_info) => { + format_error_message(formatter, &meta_info, "missing variable name") + } + ErrorInfo::InvalidEqualsLocation(ref meta_info) => { + format_error_message(formatter, &meta_info, "invalid equals sign location") + } + ErrorInfo::InvalidQuotesLocation(ref meta_info) => { + format_error_message(formatter, &meta_info, "invalid quotes location") + } + ErrorInfo::EmptyLabel(ref meta_info) => { + format_error_message(formatter, &meta_info, "empty lable found") + } + ErrorInfo::UnknownPreProcessorCommand(ref meta_info) => { + format_error_message(formatter, &meta_info, "unknow preprocessor command") + } + } + } +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +
+//! # instruction +//! +//! The instruction type. +//! + +#[cfg(test)] +#[path = "./instruction_test.rs"] +mod instruction_test; + +trait InstructionOperations { + /// Returns true if this instruction has some actionable command to run + fn is_actionable(&self) -> bool; +} + +/// Preprocess instruction +#[derive(Debug, Clone)] +pub struct PreProcessInstruction { + /// The command name + pub command: Option<String>, + /// The command arguments + pub arguments: Option<Vec<String>>, +} + +impl PreProcessInstruction { + /// Creates and returns a new instance. + pub fn new() -> PreProcessInstruction { + PreProcessInstruction { + command: None, + arguments: None, + } + } +} + +impl InstructionOperations for PreProcessInstruction { + /// Returns true if this instruction has some actionable command to run + fn is_actionable(&self) -> bool { + return self.command.is_some(); + } +} + +/// Runtime script instruction +#[derive(Debug, Clone)] +pub struct ScriptInstruction { + /// The label tag + pub label: Option<String>, + /// The command output variable name + pub output: Option<String>, + /// The command name + pub command: Option<String>, + /// The command arguments + pub arguments: Option<Vec<String>>, +} + +impl ScriptInstruction { + /// Creates and returns a new instance. + pub fn new() -> ScriptInstruction { + ScriptInstruction { + label: None, + output: None, + command: None, + arguments: None, + } + } +} + +impl InstructionOperations for ScriptInstruction { + /// Returns true if this instruction has some actionable command to run + fn is_actionable(&self) -> bool { + return self.command.is_some(); + } +} + +/// Instruction Type - script, preprocess +#[derive(Debug, Clone)] +pub enum InstructionType { + /// Empty instruction + Empty, + /// Preprocess instruction + PreProcess(PreProcessInstruction), + /// Runtime script instruction + Script(ScriptInstruction), +} + +/// Meta information for all instruction types +#[derive(Debug, Clone)] +pub struct InstructionMetaInfo { + /// The line number + pub line: Option<usize>, + /// The source file/url/... + pub source: Option<String>, +} + +impl InstructionMetaInfo { + /// Creates and returns a new instance. + pub fn new() -> InstructionMetaInfo { + InstructionMetaInfo { + line: None, + source: None, + } + } +} + +/// Instruction data +#[derive(Debug, Clone)] +pub struct Instruction { + /// Meta info + pub meta_info: InstructionMetaInfo, + /// The instruction + pub instruction_type: InstructionType, +} + +impl InstructionOperations for Instruction { + /// Returns true if this instruction has some actionable command to run + fn is_actionable(&self) -> bool { + match self.instruction_type { + InstructionType::Empty => false, + InstructionType::PreProcess(ref value) => value.is_actionable(), + InstructionType::Script(ref value) => value.is_actionable(), + } + } +} +
1 +2 +3 +4 +5 +6 +7 +8 +
+//! # types +//! +//! All duckscript types. +//! +pub mod command; +pub mod error; +pub mod instruction; +pub mod runtime; +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +
+//! # runtime +//! +//! The runtime context structures. +//! + +#[cfg(test)] +#[path = "./runtime_test.rs"] +mod runtime_test; + +use crate::types::command::Commands; +use crate::types::instruction::Instruction; +use std::collections::HashMap; + +/// enum defining what values can be stored in the state map +#[derive(Debug, Clone)] +pub enum StateValue { + /// boolean value + Boolean(bool), + /// signed number + Number(isize), + /// unsigned number + UnsignedNumber(usize), + /// signed number + Number32Bit(i32), + /// unsigned number + UnsignedNumber32Bit(u32), + /// signed number + Number64Bit(i64), + /// unsigned number + UnsignedNumber64Bit(u64), + /// textual value + String(String), + /// list + List(Vec<StateValue>), + /// sub state value + SubState(HashMap<String, StateValue>), +} + +/// The context structure +pub struct Context { + /// The runtime variables + pub variables: HashMap<String, String>, + /// The runtime state + pub state: HashMap<String, StateValue>, + /// The command implementations + pub commands: Commands, +} + +impl Context { + /// Creates and returns a new instance. + pub fn new() -> Context { + Context { + variables: HashMap::new(), + state: HashMap::new(), + commands: Commands::new(), + } + } +} + +/// The runtime structure +pub struct Runtime { + /// The script instructions + pub instructions: Option<Vec<Instruction>>, + /// Label to line number mapping + pub label_to_line: HashMap<String, usize>, + /// The runtime context + pub context: Context, +} + +impl Runtime { + /// Creates and returns a new instance. + pub fn new(context: Context) -> Runtime { + Runtime { + instructions: None, + label_to_line: HashMap::new(), + context, + } + } +} +
1 +mod.rs.html -- source \ No newline at end of file + 1 2 3 4 @@ -118,4 +118,4 @@ }) }-
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +
+use crate::utils::pckg; +use crate::utils::state::get_handles_sub_state; +use duckscript::types::command::{Command, CommandResult, Commands}; +use duckscript::types::instruction::Instruction; +use duckscript::types::runtime::StateValue; +use std::collections::HashMap; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "ArrayLength") + } + + fn aliases(&self) -> Vec<String> { + vec!["array_length".to_string(), "arrlen".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn requires_context(&self) -> bool { + true + } + + fn run_with_context( + &self, + arguments: Vec<String>, + state: &mut HashMap<String, StateValue>, + _variables: &mut HashMap<String, String>, + _output_variable: Option<String>, + _instructions: &Vec<Instruction>, + _commands: &mut Commands, + _line: usize, + ) -> CommandResult { + if arguments.is_empty() { + CommandResult::Error("Array handle not provided.".to_string()) + } else { + let state = get_handles_sub_state(state); + + let key = &arguments[0]; + + match state.get(key) { + Some(state_value) => match state_value { + StateValue::List(list) => CommandResult::Continue(Some(list.len().to_string())), + _ => CommandResult::Error("Invalid handle provided.".to_string()), + }, + None => CommandResult::Error("Array not found.".to_string()), + } + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +
+pub(crate) mod array; +mod array_length; +mod range; + +use crate::utils::pckg; +use duckscript::types::command::Commands; +use duckscript::types::error::ScriptError; + +static PACKAGE: &str = "collections"; + +pub(crate) fn load(commands: &mut Commands, parent: &str) -> Result<(), ScriptError> { + let package = pckg::concat(parent, PACKAGE); + + commands.set(array::create(&package))?; + commands.set(array_length::create(&package))?; + commands.set(range::create(&package))?; + + Ok(()) +} +
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +
+use crate::utils::pckg; +use crate::utils::state::put_handle; +use duckscript::types::command::{Command, CommandResult, Commands}; +use duckscript::types::instruction::Instruction; +use duckscript::types::runtime::StateValue; +use std::collections::HashMap; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "Range") + } + + fn aliases(&self) -> Vec<String> { + vec!["range".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn requires_context(&self) -> bool { + true + } + + fn run_with_context( + &self, + arguments: Vec<String>, + state: &mut HashMap<String, StateValue>, + _variables: &mut HashMap<String, String>, + _output_variable: Option<String>, + _instructions: &Vec<Instruction>, + _commands: &mut Commands, + _line: usize, + ) -> CommandResult { + if arguments.len() < 2 { + CommandResult::Error("Invalid arguments provided.".to_string()) + } else { + let start: i64 = match arguments[0].parse() { + Ok(value) => value, + Err(_) => { + return CommandResult::Error( + format!("Non numeric value: {} provided.", &arguments[0]).to_string(), + ); + } + }; + + let end: i64 = match arguments[1].parse() { + Ok(value) => value, + Err(_) => { + return CommandResult::Error( + format!("Non numeric value: {} provided.", &arguments[1]).to_string(), + ); + } + }; + + if start > end { + CommandResult::Error("Invalid arguments provided, range start value cannot be bigger than the range end value.".to_string()) + } else { + let array: Vec<_> = (start..end) + .map(|value| StateValue::Number64Bit(value)) + .collect(); + + let key = put_handle(state, StateValue::List(array)); + + CommandResult::Continue(Some(key)) + } + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +
use crate::utils::instruction_query; use crate::utils::pckg; @@ -586,8 +589,16 @@ StateValue::List(list) => { if list.len() > iteration { match list[iteration] { - StateValue::String(ref string_value) => Some(string_value.to_string()), - _ => None, + StateValue::Boolean(ref value) => Some(value.to_string()), + StateValue::Number(ref value) => Some(value.to_string()), + StateValue::UnsignedNumber(ref value) => Some(value.to_string()), + StateValue::Number32Bit(ref value) => Some(value.to_string()), + StateValue::UnsignedNumber32Bit(ref value) => Some(value.to_string()), + StateValue::Number64Bit(ref value) => Some(value.to_string()), + StateValue::UnsignedNumber64Bit(ref value) => Some(value.to_string()), + StateValue::String(ref value) => Some(value.to_string()), + StateValue::List(_) => None, + StateValue::SubState(_) => None, } } else { None @@ -648,7 +659,7 @@ iteration: 0, meta_info: forin_meta_info, }, - Err(error) => return CommandResult::Error(error.to_string()), + Err(error) => return CommandResult::Crash(error.to_string()), } } }; @@ -656,25 +667,20 @@ let iteration = call_info.iteration; let forin_meta_info = call_info.meta_info; - match variables.get(&arguments[2]) { - Some(handle) => match get_next_iteration(iteration, handle.to_string(), state) { - Some(next_value) => { - store_call_info( - &CallInfo { - iteration: iteration + 1, - meta_info: forin_meta_info, - }, - state, - ); + let handle = &arguments[2]; + match get_next_iteration(iteration, handle.to_string(), state) { + Some(next_value) => { + store_call_info( + &CallInfo { + iteration: iteration + 1, + meta_info: forin_meta_info, + }, + state, + ); - variables.insert(arguments[0].clone(), next_value); - CommandResult::Continue(None) - } - None => { - let next_line = forin_meta_info.end + 1; - CommandResult::GoTo(None, GoToValue::Line(next_line)) - } - }, + variables.insert(arguments[0].clone(), next_value); + CommandResult::Continue(None) + } None => { let next_line = forin_meta_info.end + 1; CommandResult::GoTo(None, GoToValue::Line(next_line)) diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/cp/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/cp/mod.rs.html index 5e1a4d0..a0de6b1 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/cp/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/cp/mod.rs.html @@ -104,7 +104,7 @@ let source_path_str = &arguments[0]; let source_path = Path::new(source_path_str); if !source_path.exists() { - CommandResult::Continue(Some("false".to_string())) + CommandResult::Error("Path does not exist.".to_string()) } else { let source_file = source_path.is_file(); @@ -114,9 +114,9 @@ match io::create_parent_directory(target_path_str) { Ok(_) => match fs::copy(source_path_str, target_path_str) { Ok(_) => CommandResult::Continue(Some("true".to_string())), - Err(_) => CommandResult::Continue(Some("false".to_string())), + Err(error) => CommandResult::Error(error.to_string()), }, - Err(_) => CommandResult::Continue(Some("false".to_string())), + Err(error) => CommandResult::Error(error.to_string()), } } else { match io::create_directory(target_path_str) { @@ -125,10 +125,10 @@ match dir::copy(source_path_str, target_path_str, &options) { Ok(_) => CommandResult::Continue(Some("true".to_string())), - Err(_) => CommandResult::Continue(Some("false".to_string())), + Err(error) => CommandResult::Error(error.to_string()), } } - Err(_) => CommandResult::Continue(Some("false".to_string())), + Err(error) => CommandResult::Error(error.to_string()), } } } diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/mkdir/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/mkdir/mod.rs.html index 52e9fb9..afad54e 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/mkdir/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/mkdir/mod.rs.html @@ -70,7 +70,7 @@ } else { match io::create_directory(&arguments[0]) { Ok(_) => CommandResult::Continue(Some("true".to_string())), - Err(_) => CommandResult::Continue(Some("false".to_string())), + Err(error) => CommandResult::Error(error.to_string()), } } } diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/mv/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/mv/mod.rs.html index c1eb3a3..dbb41e5 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/mv/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/mv/mod.rs.html @@ -101,7 +101,7 @@ let source_path = Path::new(&arguments[0]); if !source_path.exists() { - CommandResult::Continue(Some("false".to_string())) + CommandResult::Error("Path does not exist.".to_string()) } else { let target_path = Path::new(&arguments[1]); let source_file = source_path.is_file(); @@ -110,7 +110,7 @@ if source_file && target_file { match fs::rename(&arguments[0], &arguments[1]) { Ok(_) => CommandResult::Continue(Some("true".to_string())), - Err(_) => CommandResult::Continue(Some("false".to_string())), + Err(error) => CommandResult::Error(error.to_string()), } } else { match io::create_directory(&arguments[1]) { @@ -119,10 +119,10 @@ let from_paths = vec![&arguments[0]]; match move_items(&from_paths, &arguments[1], &options) { Ok(_) => CommandResult::Continue(Some("true".to_string())), - Err(_) => CommandResult::Continue(Some("false".to_string())), + Err(error) => CommandResult::Error(error.to_string()), } } - Err(_) => CommandResult::Continue(Some("false".to_string())), + Err(error) => CommandResult::Error(error.to_string()), } } } diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/print/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/print/mod.rs.html index 1f9d8c2..a8b3ae4 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/print/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/print/mod.rs.html @@ -82,7 +82,7 @@ CommandResult::Continue(Some(text)) } - Err(_) => CommandResult::Continue(None), + Err(error) => CommandResult::Error(error.to_string()), } } } diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/read/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/read/mod.rs.html index aadf5f2..b2754fa 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/read/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/read/mod.rs.html @@ -74,7 +74,7 @@ match result { Ok(text) => CommandResult::Continue(Some(text)), - Err(_) => CommandResult::Continue(None), + Err(error) => CommandResult::Error(error.to_string()), } } } diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/rm/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/rm/mod.rs.html index b26babf..e058752 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/rm/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/fs/rm/mod.rs.html @@ -120,7 +120,7 @@ match result { Ok(_) => CommandResult::Continue(Some("true".to_string())), - Err(_) => CommandResult::Continue(Some("false".to_string())), + Err(error) => CommandResult::Error(error.to_string()), } } } diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/function/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/function/mod.rs.html index dabe0cd..6d72187 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/function/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/function/mod.rs.html @@ -809,11 +809,11 @@ Err(error) => CommandResult::Error(error), } } - None => CommandResult::Error( + None => CommandResult::Crash( format!("Function: {} end not found.", &function_name).to_string(), ), }, - Err(error) => CommandResult::Error(error), + Err(error) => CommandResult::Crash(error), } } } diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/ifelse/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/ifelse/mod.rs.html index f2d186c..6291bed 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/ifelse/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/ifelse/mod.rs.html @@ -875,7 +875,7 @@ Err(error) => CommandResult::Error(error.to_string()), } } - Err(error) => CommandResult::Error(error.to_string()), + Err(error) => CommandResult::Crash(error.to_string()), } } } diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/is_defined/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/is_defined/mod.rs.html new file mode 100644 index 0000000..7282528 --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/is_defined/mod.rs.html @@ -0,0 +1,115 @@ +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/mod.rs.html index 74d1205..c438d00 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/mod.rs.html @@ -49,9 +49,19 @@ 49 50 51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +++use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult, Commands}; +use duckscript::types::instruction::Instruction; +use duckscript::types::runtime::StateValue; +use std::collections::HashMap; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "IsDefined") + } + + fn aliases(&self) -> Vec<String> { + vec!["is_defined".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn requires_context(&self) -> bool { + true + } + + fn run_with_context( + &self, + arguments: Vec<String>, + _state: &mut HashMap<String, StateValue>, + variables: &mut HashMap<String, String>, + _output_variable: Option<String>, + _instructions: &Vec<Instruction>, + _commands: &mut Commands, + _test_setline: usize, + ) -> CommandResult { + if arguments.is_empty() { + CommandResult::Error("Variable name not provided.".to_string()) + } else { + let result = variables.contains_key(&arguments[0]); + + CommandResult::Continue(Some(result.to_string())) + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +
pub(crate) mod alias; -mod array; +pub(crate) mod collections; mod echo; mod env; mod eval; @@ -60,10 +70,15 @@ mod function; mod goto; mod ifelse; +mod is_defined; mod man; mod math; +mod net; mod not; +mod on_error; +mod os_family; mod process; +mod read; mod release; mod set; mod string; @@ -74,26 +89,31 @@ use duckscript::types::command::Commands; use duckscript::types::error::ScriptError; -static PACKAGE: &str = "sdk"; +static PACKAGE: &str = "std"; pub(crate) fn load(commands: &mut Commands) -> Result<(), ScriptError> { commands.set(alias::create(PACKAGE))?; - commands.set(array::create(PACKAGE))?; commands.set(echo::create(PACKAGE))?; commands.set(eval::create(PACKAGE))?; commands.set(goto::create(PACKAGE))?; + commands.set(is_defined::create(PACKAGE))?; commands.set(man::create(PACKAGE))?; commands.set(not::create(PACKAGE))?; + commands.set(os_family::create(PACKAGE))?; + commands.set(read::create(PACKAGE))?; commands.set(release::create(PACKAGE))?; commands.set(set::create(PACKAGE))?; commands.set(unalias::create(PACKAGE))?; + collections::load(commands, PACKAGE)?; env::load(commands, PACKAGE)?; forin::load(commands, PACKAGE)?; fs::load(commands, PACKAGE)?; function::load(commands, PACKAGE)?; ifelse::load(commands, PACKAGE)?; math::load(commands, PACKAGE)?; + net::load(commands, PACKAGE)?; + on_error::load(commands, PACKAGE)?; process::load(commands, PACKAGE)?; string::load(commands, PACKAGE)?; test::load(commands, PACKAGE)?; diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/net/hostname/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/net/hostname/mod.rs.html new file mode 100644 index 0000000..486741e --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/net/hostname/mod.rs.html @@ -0,0 +1,79 @@ +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/net/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/net/mod.rs.html new file mode 100644 index 0000000..2a7ea18 --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/net/mod.rs.html @@ -0,0 +1,33 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +++use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult}; +use hostname; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "Hostname") + } + + fn aliases(&self) -> Vec<String> { + vec!["hostname".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn run(&self, _arguments: Vec<String>) -> CommandResult { + match hostname::get() { + Ok(value) => CommandResult::Continue(Some(value.to_string_lossy().into_owned())), + Err(_) => CommandResult::Continue(None), + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/get_last_error/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/get_last_error/mod.rs.html new file mode 100644 index 0000000..72ac35d --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/get_last_error/mod.rs.html @@ -0,0 +1,107 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +++mod hostname; + +use crate::utils::pckg; +use duckscript::types::command::Commands; +use duckscript::types::error::ScriptError; + +static PACKAGE: &str = "net"; + +pub(crate) fn load(commands: &mut Commands, parent: &str) -> Result<(), ScriptError> { + let package = pckg::concat(parent, PACKAGE); + + commands.set(hostname::create(&package))?; + + Ok(()) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/get_last_error_line/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/get_last_error_line/mod.rs.html new file mode 100644 index 0000000..5925c90 --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/get_last_error_line/mod.rs.html @@ -0,0 +1,107 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +++use crate::sdk::std::on_error::get_value; +use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult, Commands}; +use duckscript::types::instruction::Instruction; +use duckscript::types::runtime::StateValue; +use std::collections::HashMap; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "GetLastError") + } + + fn aliases(&self) -> Vec<String> { + vec!["get_last_error".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn requires_context(&self) -> bool { + true + } + + fn run_with_context( + &self, + _arguments: Vec<String>, + state: &mut HashMap<String, StateValue>, + _variables: &mut HashMap<String, String>, + _output_variable: Option<String>, + _instructions: &Vec<Instruction>, + _commands: &mut Commands, + _line: usize, + ) -> CommandResult { + let value = get_value(state, "error".to_string()); + CommandResult::Continue(value) + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/get_last_error_source/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/get_last_error_source/mod.rs.html new file mode 100644 index 0000000..85d331f --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/get_last_error_source/mod.rs.html @@ -0,0 +1,107 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +++use crate::sdk::std::on_error::get_value; +use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult, Commands}; +use duckscript::types::instruction::Instruction; +use duckscript::types::runtime::StateValue; +use std::collections::HashMap; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "GetLastErrorLine") + } + + fn aliases(&self) -> Vec<String> { + vec!["get_last_error_line".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn requires_context(&self) -> bool { + true + } + + fn run_with_context( + &self, + _arguments: Vec<String>, + state: &mut HashMap<String, StateValue>, + _variables: &mut HashMap<String, String>, + _output_variable: Option<String>, + _instructions: &Vec<Instruction>, + _commands: &mut Commands, + _line: usize, + ) -> CommandResult { + let value = get_value(state, "line".to_string()); + CommandResult::Continue(value) + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/mod.rs.html new file mode 100644 index 0000000..13cb6b4 --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/mod.rs.html @@ -0,0 +1,77 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +++use crate::sdk::std::on_error::get_value; +use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult, Commands}; +use duckscript::types::instruction::Instruction; +use duckscript::types::runtime::StateValue; +use std::collections::HashMap; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "GetLastErrorSource") + } + + fn aliases(&self) -> Vec<String> { + vec!["get_last_error_source".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn requires_context(&self) -> bool { + true + } + + fn run_with_context( + &self, + _arguments: Vec<String>, + state: &mut HashMap<String, StateValue>, + _variables: &mut HashMap<String, String>, + _output_variable: Option<String>, + _instructions: &Vec<Instruction>, + _commands: &mut Commands, + _line: usize, + ) -> CommandResult { + let value = get_value(state, "source".to_string()); + CommandResult::Continue(value) + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/on_error/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/on_error/mod.rs.html new file mode 100644 index 0000000..6efe7e8 --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/on_error/on_error/mod.rs.html @@ -0,0 +1,153 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +++mod get_last_error; +mod get_last_error_line; +mod get_last_error_source; +mod on_error; + +use crate::utils::pckg; +use crate::utils::state::get_core_sub_state_for_command; +use duckscript::types::command::Commands; +use duckscript::types::error::ScriptError; +use duckscript::types::runtime::StateValue; +use std::collections::HashMap; + +static PACKAGE: &str = "error"; +pub(crate) static STATE_KEY: &str = "on_error"; + +pub(crate) fn get_value(state: &mut HashMap<String, StateValue>, key: String) -> Option<String> { + let sub_state = get_core_sub_state_for_command(state, STATE_KEY.to_string()); + + match sub_state.get(&key) { + Some(state_value) => match state_value { + StateValue::String(value) => Some(value.clone()), + _ => None, + }, + None => None, + } +} + +pub(crate) fn load(commands: &mut Commands, parent: &str) -> Result<(), ScriptError> { + let package = pckg::concat(parent, PACKAGE); + + commands.set(get_last_error::create(&package))?; + commands.set(get_last_error_line::create(&package))?; + commands.set(get_last_error_source::create(&package))?; + commands.set(on_error::create(&package))?; + + Ok(()) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/os_family/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/os_family/mod.rs.html new file mode 100644 index 0000000..677b179 --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/os_family/mod.rs.html @@ -0,0 +1,87 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +++use crate::sdk::std::on_error; +use crate::utils::pckg; +use crate::utils::state::get_core_sub_state_for_command; +use duckscript::types::command::{Command, CommandResult, Commands}; +use duckscript::types::instruction::Instruction; +use duckscript::types::runtime::StateValue; +use std::collections::HashMap; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "OnError") + } + + fn aliases(&self) -> Vec<String> { + vec!["on_error".to_string()] + } + + fn help(&self) -> String { + "".to_string() + } + + fn requires_context(&self) -> bool { + true + } + + fn run_with_context( + &self, + arguments: Vec<String>, + state: &mut HashMap<String, StateValue>, + _variables: &mut HashMap<String, String>, + _output_variable: Option<String>, + _instructions: &Vec<Instruction>, + _commands: &mut Commands, + _line: usize, + ) -> CommandResult { + if !arguments.is_empty() { + let error = arguments[0].clone(); + let (line, source) = if arguments.len() > 1 { + let line = arguments[1].clone(); + let source = if arguments.len() > 2 { + arguments[2].clone() + } else { + "".to_string() + }; + + (line, source) + } else { + ("".to_string(), "".to_string()) + }; + + let sub_state = get_core_sub_state_for_command(state, on_error::STATE_KEY.to_string()); + sub_state.insert("error".to_string(), StateValue::String(error)); + sub_state.insert("line".to_string(), StateValue::String(line)); + sub_state.insert("source".to_string(), StateValue::String(source)); + + CommandResult::Continue(Some("false".to_string())) + } else { + CommandResult::Crash("Invalid input provided.".to_string()) + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/process/exit/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/process/exit/mod.rs.html index 7e7e4c7..5d5e556 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/process/exit/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/process/exit/mod.rs.html @@ -59,7 +59,7 @@ } fn aliases(&self) -> Vec<String> { - vec!["exit".to_string()] + vec!["exit".to_string(), "quit".to_string(), "q".to_string()] } fn help(&self) -> String { diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/read/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/read/mod.rs.html new file mode 100644 index 0000000..8f29505 --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/read/mod.rs.html @@ -0,0 +1,87 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +++use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult}; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "GetOSFamily") + } + + fn aliases(&self) -> Vec<String> { + vec!["os_family".to_string(), "uname".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn run(&self, _arguments: Vec<String>) -> CommandResult { + let value = if cfg!(windows) { + "windows".to_string() + } else if cfg!(target_os = "macos") || cfg!(target_os = "ios") { + "mac".to_string() + } else { + "linux".to_string() + }; + + CommandResult::Continue(Some(value)) + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/release/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/release/mod.rs.html index ddc40fd..0f18e62 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/release/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/release/mod.rs.html @@ -58,6 +58,8 @@ 58 59 60 +61 +62 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +++use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult}; +use std::io::stdin; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "ReadUserInput") + } + + fn aliases(&self) -> Vec<String> { + vec!["read".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn run(&self, _arguments: Vec<String>) -> CommandResult { + let mut text = String::new(); + + let value = match stdin().read_line(&mut text) { + Ok(_) => Some(text.trim().to_string()), + Err(_) => None, + }; + + CommandResult::Continue(value) + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +
use crate::utils::pckg; use crate::utils::state::get_handles_sub_state; @@ -106,7 +108,9 @@ } else { let state = get_handles_sub_state(state); - match state.remove(&arguments[0]) { + let key = &arguments[0]; + + match state.remove(key) { Some(_) => CommandResult::Continue(Some("true".to_string())), None => CommandResult::Continue(Some("false".to_string())), } diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/indexof/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/indexof/mod.rs.html new file mode 100644 index 0000000..923149c --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/indexof/mod.rs.html @@ -0,0 +1,93 @@ +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/is_empty/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/is_empty/mod.rs.html new file mode 100644 index 0000000..fb34f20 --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/is_empty/mod.rs.html @@ -0,0 +1,81 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +++use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult}; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "IndexOf") + } + + fn aliases(&self) -> Vec<String> { + vec!["indexof".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn run(&self, arguments: Vec<String>) -> CommandResult { + if arguments.len() < 2 { + CommandResult::Error("Two arguments are required.".to_string()) + } else { + let result = arguments[0].find(&arguments[1]); + + let result_string = match result { + Some(value) => Some(value.to_string()), + None => None, + }; + + CommandResult::Continue(result_string) + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/last_indexof/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/last_indexof/mod.rs.html new file mode 100644 index 0000000..a09794c --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/last_indexof/mod.rs.html @@ -0,0 +1,93 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +++use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult}; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "IsEmpty") + } + + fn aliases(&self) -> Vec<String> { + vec!["is_empty".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn run(&self, arguments: Vec<String>) -> CommandResult { + if arguments.is_empty() { + CommandResult::Continue(Some("true".to_string())) + } else { + let result = arguments[0].is_empty(); + CommandResult::Continue(Some(result.to_string())) + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/length/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/length/mod.rs.html new file mode 100644 index 0000000..88a366f --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/length/mod.rs.html @@ -0,0 +1,83 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +++use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult}; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "LastIndexOf") + } + + fn aliases(&self) -> Vec<String> { + vec!["last_indexof".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn run(&self, arguments: Vec<String>) -> CommandResult { + if arguments.len() < 2 { + CommandResult::Error("Two arguments are required.".to_string()) + } else { + let result = arguments[0].rfind(&arguments[1]); + + let result_string = match result { + Some(value) => Some(value.to_string()), + None => None, + }; + + CommandResult::Continue(result_string) + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/mod.rs.html index 0d977b3..007394b 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/mod.rs.html @@ -19,11 +19,35 @@ 19 20 21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +++use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult}; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "Length") + } + + fn aliases(&self) -> Vec<String> { + vec!["length".to_string(), "strlen".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn run(&self, arguments: Vec<String>) -> CommandResult { + if arguments.is_empty() { + CommandResult::Error("No argument provided.".to_string()) + } else { + let string_len = arguments[0].len(); + + CommandResult::Continue(Some(string_len.to_string())) + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +
mod contains; mod ends_with; mod equals; +mod indexof; +mod is_empty; +mod last_indexof; +mod length; mod starts_with; +mod substring; +mod trim; +mod trim_end; +mod trim_start; use crate::utils::pckg; use duckscript::types::command::Commands; @@ -37,7 +61,15 @@ commands.set(contains::create(&package))?; commands.set(ends_with::create(&package))?; commands.set(equals::create(&package))?; + commands.set(indexof::create(&package))?; + commands.set(is_empty::create(&package))?; + commands.set(last_indexof::create(&package))?; + commands.set(length::create(&package))?; commands.set(starts_with::create(&package))?; + commands.set(substring::create(&package))?; + commands.set(trim::create(&package))?; + commands.set(trim_start::create(&package))?; + commands.set(trim_end::create(&package))?; Ok(()) } diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/substring/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/substring/mod.rs.html new file mode 100644 index 0000000..85b4188 --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/substring/mod.rs.html @@ -0,0 +1,239 @@ +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/trim/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/trim/mod.rs.html new file mode 100644 index 0000000..2fdea64 --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/trim/mod.rs.html @@ -0,0 +1,81 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +++use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult}; +use std::convert::TryInto; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +fn parse_number(string_value: &str) -> Result<isize, String> { + match string_value.parse() { + Ok(value) => Ok(value), + Err(_) => Err(format!("Non numeric value: {} provided.", string_value).to_string()), + } +} + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "SubString") + } + + fn aliases(&self) -> Vec<String> { + vec!["substring".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn run(&self, arguments: Vec<String>) -> CommandResult { + if arguments.is_empty() { + CommandResult::Error("No arguments provided.".to_string()) + } else { + let string_value = arguments[0].clone(); + let string_len = string_value.len() as isize; + + let (start, end) = if arguments.len() == 1 { + (0, string_len) + } else if arguments.len() == 2 { + match parse_number(&arguments[1]) { + Ok(value) => { + if value >= 0 { + if value > (string_len - 1) { + return CommandResult::Error( + "Start index cannot be bigger than total text size." + .to_string(), + ); + } else { + (value, string_len) + } + } else { + let end_index = value + string_len; + + if end_index < 0 { + return CommandResult::Error( + "Index from end cannot be bigger than total text size." + .to_string(), + ); + } else { + (0, end_index) + } + } + } + Err(error) => return CommandResult::Error(error.to_string()), + } + } else { + let start = match parse_number(&arguments[1]) { + Ok(value) => { + if value > (string_len - 1) { + return CommandResult::Error( + "Start index cannot be bigger than total text size.".to_string(), + ); + } else { + value + } + } + Err(error) => return CommandResult::Error(error.to_string()), + }; + let end = match parse_number(&arguments[2]) { + Ok(value) => { + if value >= start { + if value > (string_len - 1) { + return CommandResult::Error( + "End index cannot be bigger than total text size.".to_string(), + ); + } else { + value + } + } else { + return CommandResult::Error( + "End index cannot be smaller than start index.".to_string(), + ); + } + } + Err(error) => return CommandResult::Error(error.to_string()), + }; + + (start, end) + }; + + let start_index: usize = start.try_into().unwrap(); + let end_index: usize = end.try_into().unwrap(); + + let sub_string = &string_value.as_str()[start_index..end_index]; + + CommandResult::Continue(Some(sub_string.to_string())) + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/trim_end/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/trim_end/mod.rs.html new file mode 100644 index 0000000..71c2cb2 --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/trim_end/mod.rs.html @@ -0,0 +1,81 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +++use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult}; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "Trim") + } + + fn aliases(&self) -> Vec<String> { + vec!["trim".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn run(&self, arguments: Vec<String>) -> CommandResult { + if arguments.is_empty() { + CommandResult::Continue(None) + } else { + let result = arguments[0].trim(); + CommandResult::Continue(Some(result.to_string())) + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/trim_start/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/trim_start/mod.rs.html new file mode 100644 index 0000000..4205422 --- /dev/null +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/string/trim_start/mod.rs.html @@ -0,0 +1,81 @@ + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +++use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult}; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "TrimEnd") + } + + fn aliases(&self) -> Vec<String> { + vec!["trim_end".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn run(&self, arguments: Vec<String>) -> CommandResult { + if arguments.is_empty() { + CommandResult::Continue(None) + } else { + let result = arguments[0].trim_end(); + CommandResult::Continue(Some(result.to_string())) + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +mod.rs.html -- source \ No newline at end of file diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/thread/sleep/mod.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/thread/sleep/mod.rs.html index 07d738b..e002c53 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/thread/sleep/mod.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/sdk/std/thread/sleep/mod.rs.html @@ -101,7 +101,7 @@ } } Err(_) => CommandResult::Error( - format!("Non numberic value: {} provided.", &arguments[0]).to_string(), + format!("Non numeric value: {} provided.", &arguments[0]).to_string(), ), } } diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/utils/eval.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/utils/eval.rs.html index d8636f5..977ed86 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/utils/eval.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/utils/eval.rs.html @@ -46,6 +46,8 @@ 46 47 48 +49 +50 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +++use crate::utils::pckg; +use duckscript::types::command::{Command, CommandResult}; + +#[cfg(test)] +#[path = "./mod_test.rs"] +mod mod_test; + +struct CommandImpl { + package: String, +} + +impl Command for CommandImpl { + fn name(&self) -> String { + pckg::concat(&self.package, "TrimStart") + } + + fn aliases(&self) -> Vec<String> { + vec!["trim_start".to_string()] + } + + fn help(&self) -> String { + include_str!("help.md").to_string() + } + + fn run(&self, arguments: Vec<String>) -> CommandResult { + if arguments.is_empty() { + CommandResult::Continue(None) + } else { + let result = arguments[0].trim_start(); + CommandResult::Continue(Some(result.to_string())) + } + } +} + +pub(crate) fn create(package: &str) -> Box<dyn Command> { + Box::new(CommandImpl { + package: package.to_string(), + }) +} +
use duckscript::parser; use duckscript::runner; @@ -78,7 +80,9 @@ line_buffer.push(' '); } - match parser::parse_text(&line_buffer) { + let line_str = line_buffer.replace("\r", "").replace("\n", ""); + + match parser::parse_text(&line_str) { Ok(instructions) => { let (command_result, _) = runner::run_instruction( commands, diff --git a/docs/api/duckscript_sdk/src/duckscriptsdk/utils/state.rs.html b/docs/api/duckscript_sdk/src/duckscriptsdk/utils/state.rs.html index 6878bcb..5cbf3c6 100644 --- a/docs/api/duckscript_sdk/src/duckscriptsdk/utils/state.rs.html +++ b/docs/api/duckscript_sdk/src/duckscriptsdk/utils/state.rs.html @@ -136,7 +136,7 @@ state: &mut HashMap<String, StateValue>, name: String, ) -> &mut HashMap<String, StateValue> { - let sub_state_name = pckg::concat("duckscript", &name); + let sub_state_name = pckg::concat("duckscriptsdk", &name); get_sub_state(sub_state_name, state) }