mirror of
https://github.com/RGBCube/serenity
synced 2025-07-26 00:27:43 +00:00
Shell: Start implementing a POSIX-compliant parser
The parser is still very much a work-in-progress, but it can currently parse most of the basic bits, the only *completely* unimplemented things in the parser are: - heredocs (io_here) - alias expansion - arithmetic expansion There are a whole suite of bugs, and syntax highlighting is unreliable at best. For now, this is not attached anywhere, a future commit will enable it for /bin/sh or a `Shell --posix` invocation.
This commit is contained in:
Ali Mohammad Pur
Ali Mohammad Pur
parent
2dc1682274
commit
2a276c86d4
14 changed files with 3444 additions and 28 deletions
413
Userland/Shell/PosixLexer.h
Normal file
413
Userland/Shell/PosixLexer.h
Normal file
|
|
@ -0,0 +1,413 @@
|
|||
/*
|
||||
* Copyright (c) 2022, Ali Mohammad Pur <mpfard@serenityos.org>
|
||||
*
|
||||
* SPDX-License-Identifier: BSD-2-Clause
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <AK/DeprecatedString.h>
|
||||
#include <AK/GenericLexer.h>
|
||||
#include <AK/Variant.h>
|
||||
#include <AK/Vector.h>
|
||||
#include <Shell/AST.h>
|
||||
|
||||
namespace Shell::Posix {
|
||||
|
||||
enum class Reduction {
|
||||
None,
|
||||
End,
|
||||
Operator,
|
||||
Comment,
|
||||
SingleQuotedString,
|
||||
DoubleQuotedString,
|
||||
Expansion,
|
||||
CommandExpansion,
|
||||
Start,
|
||||
ArithmeticExpansion,
|
||||
SpecialParameterExpansion,
|
||||
ParameterExpansion,
|
||||
CommandOrArithmeticSubstitutionExpansion,
|
||||
ExtendedParameterExpansion,
|
||||
};
|
||||
|
||||
struct ExpansionRange {
|
||||
size_t start;
|
||||
size_t length;
|
||||
};
|
||||
|
||||
struct ParameterExpansion {
|
||||
StringBuilder parameter;
|
||||
ExpansionRange range;
|
||||
};
|
||||
|
||||
struct CommandExpansion {
|
||||
StringBuilder command;
|
||||
ExpansionRange range;
|
||||
};
|
||||
|
||||
struct ArithmeticExpansion {
|
||||
DeprecatedString expression;
|
||||
StringBuilder value;
|
||||
ExpansionRange range;
|
||||
};
|
||||
|
||||
using Expansion = Variant<ParameterExpansion, CommandExpansion, ArithmeticExpansion>;
|
||||
|
||||
struct ResolvedParameterExpansion {
|
||||
DeprecatedString parameter;
|
||||
DeprecatedString argument;
|
||||
ExpansionRange range;
|
||||
enum class Op {
|
||||
UseDefaultValue, // ${parameter:-word}
|
||||
AssignDefaultValue, // ${parameter:=word}
|
||||
IndicateErrorIfEmpty, // ${parameter:?word}
|
||||
UseAlternativeValue, // ${parameter:+word}
|
||||
UseDefaultValueIfUnset, // ${parameter-default}
|
||||
AssignDefaultValueIfUnset, // ${parameter=default}
|
||||
IndicateErrorIfUnset, // ${parameter?default}
|
||||
UseAlternativeValueIfUnset, // ${parameter+default}
|
||||
RemoveLargestSuffixByPattern, // ${parameter%%pattern}
|
||||
RemoveLargestPrefixByPattern, // ${parameter##pattern}
|
||||
RemoveSmallestSuffixByPattern, // ${parameter%pattern}
|
||||
RemoveSmallestPrefixByPattern, // ${parameter#pattern}
|
||||
StringLength, // ${#parameter}
|
||||
GetPositionalParameter, // ${parameter}
|
||||
GetVariable, // ${parameter}
|
||||
GetLastBackgroundPid, // $!
|
||||
GetPositionalParameterList, // $*
|
||||
GetCurrentOptionFlags, // $-
|
||||
GetPositionalParameterCount, // $#
|
||||
GetLastExitStatus, // $?
|
||||
GetPositionalParameterListAsString, // $@
|
||||
GetShellProcessId, // $$
|
||||
} op;
|
||||
|
||||
enum class Expand {
|
||||
Nothing,
|
||||
Word,
|
||||
} expand { Expand::Nothing };
|
||||
|
||||
DeprecatedString to_deprecated_string() const
|
||||
{
|
||||
StringBuilder builder;
|
||||
builder.append("{"sv);
|
||||
switch (op) {
|
||||
case Op::UseDefaultValue:
|
||||
builder.append("UseDefaultValue"sv);
|
||||
break;
|
||||
case Op::AssignDefaultValue:
|
||||
builder.append("AssignDefaultValue"sv);
|
||||
break;
|
||||
case Op::IndicateErrorIfEmpty:
|
||||
builder.append("IndicateErrorIfEmpty"sv);
|
||||
break;
|
||||
case Op::UseAlternativeValue:
|
||||
builder.append("UseAlternativeValue"sv);
|
||||
break;
|
||||
case Op::UseDefaultValueIfUnset:
|
||||
builder.append("UseDefaultValueIfUnset"sv);
|
||||
break;
|
||||
case Op::AssignDefaultValueIfUnset:
|
||||
builder.append("AssignDefaultValueIfUnset"sv);
|
||||
break;
|
||||
case Op::IndicateErrorIfUnset:
|
||||
builder.append("IndicateErrorIfUnset"sv);
|
||||
break;
|
||||
case Op::UseAlternativeValueIfUnset:
|
||||
builder.append("UseAlternativeValueIfUnset"sv);
|
||||
break;
|
||||
case Op::RemoveLargestSuffixByPattern:
|
||||
builder.append("RemoveLargestSuffixByPattern"sv);
|
||||
break;
|
||||
case Op::RemoveLargestPrefixByPattern:
|
||||
builder.append("RemoveLargestPrefixByPattern"sv);
|
||||
break;
|
||||
case Op::RemoveSmallestSuffixByPattern:
|
||||
builder.append("RemoveSmallestSuffixByPattern"sv);
|
||||
break;
|
||||
case Op::RemoveSmallestPrefixByPattern:
|
||||
builder.append("RemoveSmallestPrefixByPattern"sv);
|
||||
break;
|
||||
case Op::StringLength:
|
||||
builder.append("StringLength"sv);
|
||||
break;
|
||||
case Op::GetPositionalParameter:
|
||||
builder.append("GetPositionalParameter"sv);
|
||||
break;
|
||||
case Op::GetLastBackgroundPid:
|
||||
builder.append("GetLastBackgroundPid"sv);
|
||||
break;
|
||||
case Op::GetPositionalParameterList:
|
||||
builder.append("GetPositionalParameterList"sv);
|
||||
break;
|
||||
case Op::GetCurrentOptionFlags:
|
||||
builder.append("GetCurrentOptionFlags"sv);
|
||||
break;
|
||||
case Op::GetPositionalParameterCount:
|
||||
builder.append("GetPositionalParameterCount"sv);
|
||||
break;
|
||||
case Op::GetLastExitStatus:
|
||||
builder.append("GetLastExitStatus"sv);
|
||||
break;
|
||||
case Op::GetPositionalParameterListAsString:
|
||||
builder.append("GetPositionalParameterListAsString"sv);
|
||||
break;
|
||||
case Op::GetShellProcessId:
|
||||
builder.append("GetShellProcessId"sv);
|
||||
break;
|
||||
case Op::GetVariable:
|
||||
builder.append("GetVariable"sv);
|
||||
break;
|
||||
}
|
||||
builder.append(" "sv);
|
||||
builder.append(parameter);
|
||||
builder.append(" ("sv);
|
||||
builder.append(argument);
|
||||
builder.append(")"sv);
|
||||
builder.append("}"sv);
|
||||
return builder.to_deprecated_string();
|
||||
}
|
||||
};
|
||||
|
||||
struct ResolvedCommandExpansion {
|
||||
RefPtr<AST::Node> command;
|
||||
ExpansionRange range;
|
||||
};
|
||||
|
||||
using ResolvedExpansion = Variant<ResolvedParameterExpansion, ResolvedCommandExpansion>;
|
||||
|
||||
struct State {
|
||||
StringBuilder buffer {};
|
||||
Reduction previous_reduction { Reduction::Start };
|
||||
bool escaping { false };
|
||||
AST::Position position {
|
||||
.start_offset = 0,
|
||||
.end_offset = 0,
|
||||
.start_line = {
|
||||
.line_number = 0,
|
||||
.line_column = 0,
|
||||
},
|
||||
.end_line = {
|
||||
.line_number = 0,
|
||||
.line_column = 0,
|
||||
},
|
||||
};
|
||||
Vector<Expansion> expansions {};
|
||||
};
|
||||
|
||||
struct Token {
|
||||
enum class Type {
|
||||
Eof,
|
||||
Newline,
|
||||
Continuation,
|
||||
Token,
|
||||
And,
|
||||
Pipe,
|
||||
OpenParen,
|
||||
CloseParen,
|
||||
Great,
|
||||
Less,
|
||||
AndIf,
|
||||
OrIf,
|
||||
DoubleSemicolon,
|
||||
DoubleLess,
|
||||
DoubleGreat,
|
||||
LessAnd,
|
||||
GreatAnd,
|
||||
LessGreat,
|
||||
DoubleLessDash,
|
||||
Clobber,
|
||||
Semicolon,
|
||||
|
||||
// Not produced by this lexer, but generated in later stages.
|
||||
AssignmentWord,
|
||||
Bang,
|
||||
Case,
|
||||
CloseBrace,
|
||||
Do,
|
||||
Done,
|
||||
Elif,
|
||||
Else,
|
||||
Esac,
|
||||
Fi,
|
||||
For,
|
||||
If,
|
||||
In,
|
||||
IoNumber,
|
||||
OpenBrace,
|
||||
Then,
|
||||
Until,
|
||||
VariableName,
|
||||
While,
|
||||
Word,
|
||||
};
|
||||
|
||||
Type type;
|
||||
DeprecatedString value;
|
||||
Optional<AST::Position> position;
|
||||
Vector<Expansion> expansions;
|
||||
Vector<ResolvedExpansion> resolved_expansions {};
|
||||
StringView original_text;
|
||||
bool could_be_start_of_a_simple_command { false };
|
||||
|
||||
static Vector<Token> maybe_from_state(State const& state)
|
||||
{
|
||||
if (state.buffer.is_empty() || state.buffer.string_view().trim_whitespace().is_empty())
|
||||
return {};
|
||||
|
||||
auto token = Token {
|
||||
.type = Type::Token,
|
||||
.value = state.buffer.to_deprecated_string(),
|
||||
.position = state.position,
|
||||
.expansions = state.expansions,
|
||||
.original_text = {},
|
||||
};
|
||||
return { move(token) };
|
||||
}
|
||||
|
||||
static Optional<Token::Type> operator_from_name(StringView name)
|
||||
{
|
||||
if (name == "&&"sv)
|
||||
return Token::Type::AndIf;
|
||||
if (name == "||"sv)
|
||||
return Token::Type::OrIf;
|
||||
if (name == ";;"sv)
|
||||
return Token::Type::DoubleSemicolon;
|
||||
if (name == "<<"sv)
|
||||
return Token::Type::DoubleLess;
|
||||
if (name == ">>"sv)
|
||||
return Token::Type::DoubleGreat;
|
||||
if (name == "<&"sv)
|
||||
return Token::Type::LessAnd;
|
||||
if (name == ">&"sv)
|
||||
return Token::Type::GreatAnd;
|
||||
if (name == "<>"sv)
|
||||
return Token::Type::LessGreat;
|
||||
if (name == "<<-"sv)
|
||||
return Token::Type::DoubleLessDash;
|
||||
if (name == ">|"sv)
|
||||
return Token::Type::Clobber;
|
||||
if (name == ";"sv)
|
||||
return Token::Type::Semicolon;
|
||||
if (name == "&"sv)
|
||||
return Token::Type::And;
|
||||
if (name == "|"sv)
|
||||
return Token::Type::Pipe;
|
||||
if (name == "("sv)
|
||||
return Token::Type::OpenParen;
|
||||
if (name == ")"sv)
|
||||
return Token::Type::CloseParen;
|
||||
if (name == ">"sv)
|
||||
return Token::Type::Great;
|
||||
if (name == "<"sv)
|
||||
return Token::Type::Less;
|
||||
|
||||
return {};
|
||||
}
|
||||
|
||||
static Vector<Token> operators_from(State const& state)
|
||||
{
|
||||
auto name = state.buffer.string_view();
|
||||
auto type = operator_from_name(name);
|
||||
if (!type.has_value())
|
||||
return {};
|
||||
|
||||
return {
|
||||
Token {
|
||||
.type = *type,
|
||||
.value = name,
|
||||
.position = state.position,
|
||||
.expansions = {},
|
||||
.original_text = {},
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
static Token eof()
|
||||
{
|
||||
return {
|
||||
.type = Type::Eof,
|
||||
.value = {},
|
||||
.position = {},
|
||||
.expansions = {},
|
||||
.original_text = {},
|
||||
};
|
||||
}
|
||||
|
||||
static Token newline()
|
||||
{
|
||||
return {
|
||||
.type = Type::Newline,
|
||||
.value = "\n",
|
||||
.position = {},
|
||||
.expansions = {},
|
||||
.original_text = {},
|
||||
};
|
||||
}
|
||||
|
||||
static Token continuation(char expected)
|
||||
{
|
||||
return {
|
||||
.type = Type::Continuation,
|
||||
.value = DeprecatedString::formatted("{:c}", expected),
|
||||
.position = {},
|
||||
.expansions = {},
|
||||
.original_text = {},
|
||||
};
|
||||
}
|
||||
|
||||
static Token continuation(DeprecatedString expected)
|
||||
{
|
||||
return {
|
||||
.type = Type::Continuation,
|
||||
.value = move(expected),
|
||||
.position = {},
|
||||
.expansions = {},
|
||||
.original_text = {},
|
||||
};
|
||||
}
|
||||
|
||||
StringView type_name() const;
|
||||
};
|
||||
|
||||
class Lexer {
|
||||
public:
|
||||
explicit Lexer(StringView input)
|
||||
: m_lexer(input)
|
||||
{
|
||||
}
|
||||
|
||||
Vector<Token> batch_next();
|
||||
|
||||
private:
|
||||
struct ReductionResult {
|
||||
Vector<Token> tokens;
|
||||
Reduction next_reduction { Reduction::None };
|
||||
};
|
||||
|
||||
ReductionResult reduce(Reduction);
|
||||
ReductionResult reduce_end();
|
||||
ReductionResult reduce_operator();
|
||||
ReductionResult reduce_comment();
|
||||
ReductionResult reduce_single_quoted_string();
|
||||
ReductionResult reduce_double_quoted_string();
|
||||
ReductionResult reduce_expansion();
|
||||
ReductionResult reduce_command_expansion();
|
||||
ReductionResult reduce_start();
|
||||
ReductionResult reduce_arithmetic_expansion();
|
||||
ReductionResult reduce_special_parameter_expansion();
|
||||
ReductionResult reduce_parameter_expansion();
|
||||
ReductionResult reduce_command_or_arithmetic_substitution_expansion();
|
||||
ReductionResult reduce_extended_parameter_expansion();
|
||||
|
||||
char consume();
|
||||
bool consume_specific(char);
|
||||
ExpansionRange range(ssize_t offset = 0) const;
|
||||
|
||||
GenericLexer m_lexer;
|
||||
State m_state;
|
||||
Reduction m_next_reduction { Reduction::Start };
|
||||
};
|
||||
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue