PosixParser.cpp 79 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248
  1. /*
  2. * Copyright (c) 2022, Ali Mohammad Pur <mpfard@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/CharacterTypes.h>
  7. #include <AK/Debug.h>
  8. #include <AK/StringUtils.h>
  9. #include <Shell/Parser.h>
  10. #include <Shell/PosixParser.h>
  11. #define TRY_OR_THROW_PARSE_ERROR_AT(expr, position) ({ \
  12. /* Ignore -Wshadow to allow nesting the macro. */ \
  13. AK_IGNORE_DIAGNOSTIC("-Wshadow", \
  14. auto&& _value_or_error = expr;) \
  15. if (_value_or_error.is_error()) { \
  16. AK_IGNORE_DIAGNOSTIC("-Wshadow", \
  17. auto _error = _value_or_error.release_error();) \
  18. if (_error.is_errno() && _error.code() == ENOMEM) \
  19. return make_ref_counted<AST::SyntaxError>(position, "OOM"_string); \
  20. return make_ref_counted<AST::SyntaxError>(position, MUST(String::formatted("Error: {}", _error))); \
  21. } \
  22. _value_or_error.release_value(); \
  23. })
  24. static RefPtr<Shell::AST::Node> strip_execute(RefPtr<Shell::AST::Node> node)
  25. {
  26. while (node && node->is_execute())
  27. node = static_ptr_cast<Shell::AST::Execute>(node)->command();
  28. return node;
  29. }
  30. static Shell::AST::Position empty_position()
  31. {
  32. return { 0, 0, { 0, 0 }, { 0, 0 } };
  33. }
  34. template<typename T, typename... Ts>
  35. static inline bool is_one_of(T const& value, Ts const&... values)
  36. {
  37. return ((value == values) || ...);
  38. }
  39. static inline bool is_io_operator(Shell::Posix::Token const& token)
  40. {
  41. using namespace Shell::Posix;
  42. return is_one_of(token.type,
  43. Token::Type::Less, Token::Type::Great,
  44. Token::Type::LessAnd, Token::Type::GreatAnd,
  45. Token::Type::DoubleLess, Token::Type::DoubleGreat,
  46. Token::Type::DoubleLessDash, Token::Type::LessGreat,
  47. Token::Type::Clobber);
  48. }
  49. static inline bool is_separator(Shell::Posix::Token const& token)
  50. {
  51. using namespace Shell::Posix;
  52. return is_one_of(token.type,
  53. Token::Type::Semicolon, Token::Type::Newline,
  54. Token::Type::AndIf, Token::Type::OrIf,
  55. Token::Type::Pipe,
  56. Token::Type::And);
  57. }
  58. static inline bool is_a_reserved_word_position(Shell::Posix::Token const& token, Optional<Shell::Posix::Token> const& previous_token, Optional<Shell::Posix::Token> const& previous_previous_token)
  59. {
  60. using namespace Shell::Posix;
  61. auto is_start_of_command = !previous_token.has_value()
  62. || previous_token->value.is_empty()
  63. || is_separator(*previous_token)
  64. || is_one_of(previous_token->type,
  65. Token::Type::OpenParen, Token::Type::CloseParen, Token::Type::Newline, Token::Type::DoubleSemicolon,
  66. Token::Type::Semicolon, Token::Type::Pipe, Token::Type::OrIf, Token::Type::AndIf);
  67. if (is_start_of_command)
  68. return true;
  69. if (!previous_token.has_value())
  70. return false;
  71. auto previous_is_reserved_word = is_one_of(previous_token->value,
  72. "for"sv, "in"sv, "case"sv, "if"sv, "then"sv, "else"sv,
  73. "elif"sv, "while"sv, "until"sv, "do"sv, "done"sv, "esac"sv,
  74. "fi"sv, "!"sv, "{"sv, "}"sv);
  75. if (previous_is_reserved_word)
  76. return true;
  77. if (!previous_previous_token.has_value())
  78. return false;
  79. auto is_third_in_case = previous_previous_token->value == "case"sv
  80. && token.type == Token::Type::Token && token.value == "in"sv;
  81. if (is_third_in_case)
  82. return true;
  83. auto is_third_in_for = previous_previous_token->value == "for"sv
  84. && token.type == Token::Type::Token && is_one_of(token.value, "in"sv, "do"sv);
  85. return is_third_in_for;
  86. }
  87. static inline bool is_reserved(Shell::Posix::Token const& token)
  88. {
  89. using namespace Shell::Posix;
  90. return is_one_of(token.type,
  91. Token::Type::If, Token::Type::Then, Token::Type::Else,
  92. Token::Type::Elif, Token::Type::Fi, Token::Type::Do,
  93. Token::Type::Done, Token::Type::Case, Token::Type::Esac,
  94. Token::Type::While, Token::Type::Until, Token::Type::For,
  95. Token::Type::In, Token::Type::OpenBrace, Token::Type::CloseBrace,
  96. Token::Type::Bang);
  97. }
  98. static inline bool is_valid_name(StringView word)
  99. {
  100. // Dr.POSIX: a word consisting solely of underscores, digits, and alphabetics from the portable character set. The first character of a name is not a digit.
  101. return !word.is_empty()
  102. && !is_ascii_digit(word[0])
  103. && all_of(word, [](auto ch) { return is_ascii_alphanumeric(ch) || ch == '_'; });
  104. }
  105. namespace Shell::Posix {
  106. ErrorOr<void> Parser::fill_token_buffer(Optional<Reduction> starting_reduction)
  107. {
  108. for (;;) {
  109. auto token = TRY(next_expanded_token(starting_reduction));
  110. if (!token.has_value())
  111. break;
  112. #if SHELL_POSIX_PARSER_DEBUG
  113. DeprecatedString position = "(~)";
  114. if (token->position.has_value())
  115. position = DeprecatedString::formatted("{}:{}", token->position->start_offset, token->position->end_offset);
  116. DeprecatedString expansions = "";
  117. for (auto& exp : token->resolved_expansions)
  118. exp.visit(
  119. [&](ResolvedParameterExpansion& x) { expansions = DeprecatedString::formatted("{}param({}),", expansions, x.to_deprecated_string()); },
  120. [&](ResolvedCommandExpansion& x) { expansions = DeprecatedString::formatted("{}command({:p})", expansions, x.command.ptr()); },
  121. [&](ResolvedArithmeticExpansion& x) { expansions = DeprecatedString::formatted("{}arith({})", expansions, x.source_expression); });
  122. DeprecatedString rexpansions = "";
  123. for (auto& exp : token->expansions)
  124. exp.visit(
  125. [&](ParameterExpansion& x) { rexpansions = DeprecatedString::formatted("{}param({}) from {} to {},", rexpansions, x.parameter.string_view(), x.range.start, x.range.length); },
  126. [&](auto&) { rexpansions = DeprecatedString::formatted("{}...,", rexpansions); });
  127. dbgln("Token @ {}: '{}' (type {}) - parsed expansions: {} - raw expansions: {}", position, token->value.replace("\n"sv, "\\n"sv, ReplaceMode::All), token->type_name(), expansions, rexpansions);
  128. #endif
  129. }
  130. m_token_index = 0;
  131. // Detect Assignment words, bash-like lists extension
  132. for (size_t i = 1; i < m_token_buffer.size(); ++i) {
  133. // Treat 'ASSIGNMENT_WORD OPEN_PAREN' where ASSIGNMENT_WORD is `word=' and OPEN_PAREN has no preceding trivia as a bash-like list assignment.
  134. auto& token = m_token_buffer[i - 1];
  135. auto& next_token = m_token_buffer[i];
  136. if (token.type != Token::Type::AssignmentWord)
  137. continue;
  138. if (!token.value.ends_with('='))
  139. continue;
  140. if (next_token.type != Token::Type::OpenParen)
  141. continue;
  142. if (token.position.map([](auto& x) { return x.end_offset + 1; }) != next_token.position.map([](auto& x) { return x.start_offset; }))
  143. continue;
  144. token.type = Token::Type::ListAssignmentWord;
  145. }
  146. return {};
  147. }
  148. RefPtr<AST::Node> Parser::parse()
  149. {
  150. auto start_position = peek().position.value_or(empty_position());
  151. return TRY_OR_THROW_PARSE_ERROR_AT(parse_complete_command(), start_position);
  152. }
  153. void Parser::handle_heredoc_contents()
  154. {
  155. while (!eof() && m_token_buffer[m_token_index].type == Token::Type::HeredocContents) {
  156. auto& token = m_token_buffer[m_token_index++];
  157. auto entry = m_unprocessed_heredoc_entries.get(token.relevant_heredoc_key.value());
  158. if (!entry.has_value()) {
  159. error(token, "Discarding unexpected heredoc contents for key '{}'", *token.relevant_heredoc_key);
  160. continue;
  161. }
  162. auto& heredoc = **entry;
  163. auto contents_or_error = [&]() -> ErrorOr<RefPtr<AST::Node>> {
  164. if (heredoc.allow_interpolation()) {
  165. Parser parser { token.value, m_in_interactive_mode, Reduction::HeredocContents };
  166. return parser.parse_word();
  167. }
  168. return make_ref_counted<AST::StringLiteral>(
  169. token.position.value_or(empty_position()),
  170. TRY(String::from_utf8(token.value)),
  171. AST::StringLiteral::EnclosureType::None);
  172. }();
  173. if (contents_or_error.is_error()) {
  174. warnln("Shell: Failed to parse heredoc contents: {}", contents_or_error.error());
  175. continue;
  176. }
  177. if (auto contents = contents_or_error.release_value())
  178. heredoc.set_contents(contents);
  179. m_unprocessed_heredoc_entries.remove(*token.relevant_heredoc_key);
  180. }
  181. }
  182. ErrorOr<Optional<Token>> Parser::next_expanded_token(Optional<Reduction> starting_reduction)
  183. {
  184. while (m_token_buffer.is_empty() || m_token_buffer.last().type != Token::Type::Eof) {
  185. auto tokens = TRY(m_lexer.batch_next(starting_reduction));
  186. auto expanded = perform_expansions(move(tokens));
  187. m_token_buffer.extend(expanded);
  188. }
  189. if (m_token_buffer.size() == m_token_index)
  190. return OptionalNone {};
  191. return m_token_buffer[m_token_index++];
  192. }
  193. Vector<Token> Parser::perform_expansions(Vector<Token> tokens)
  194. {
  195. if (tokens.is_empty())
  196. return {};
  197. Vector<Token> expanded_tokens;
  198. auto previous_token = Optional<Token>();
  199. auto previous_previous_token = Optional<Token>();
  200. auto tokens_taken_from_buffer = 0;
  201. expanded_tokens.ensure_capacity(tokens.size());
  202. auto swap_expansions = [&] {
  203. if (previous_previous_token.has_value())
  204. expanded_tokens.append(previous_previous_token.release_value());
  205. if (previous_token.has_value())
  206. expanded_tokens.append(previous_token.release_value());
  207. for (; tokens_taken_from_buffer > 0; tokens_taken_from_buffer--)
  208. m_token_buffer.append(expanded_tokens.take_first());
  209. swap(tokens, expanded_tokens);
  210. expanded_tokens.clear_with_capacity();
  211. };
  212. // (1) join all consecutive newlines (this works around a grammar ambiguity)
  213. auto previous_was_newline = !m_token_buffer.is_empty() && m_token_buffer.last().type == Token::Type::Newline;
  214. for (auto& token : tokens) {
  215. if (token.type == Token::Type::Newline) {
  216. if (previous_was_newline)
  217. continue;
  218. previous_was_newline = true;
  219. } else {
  220. previous_was_newline = false;
  221. }
  222. expanded_tokens.append(move(token));
  223. }
  224. swap_expansions();
  225. // (2) Detect reserved words
  226. if (m_token_buffer.size() >= 1) {
  227. previous_token = m_token_buffer.take_last();
  228. tokens_taken_from_buffer++;
  229. }
  230. if (m_token_buffer.size() >= 1) {
  231. previous_previous_token = m_token_buffer.take_last();
  232. tokens_taken_from_buffer++;
  233. }
  234. auto check_reserved_word = [&](auto& token) {
  235. if (is_a_reserved_word_position(token, previous_token, previous_previous_token)) {
  236. if (token.value == "if"sv)
  237. token.type = Token::Type::If;
  238. else if (token.value == "then"sv)
  239. token.type = Token::Type::Then;
  240. else if (token.value == "else"sv)
  241. token.type = Token::Type::Else;
  242. else if (token.value == "elif"sv)
  243. token.type = Token::Type::Elif;
  244. else if (token.value == "fi"sv)
  245. token.type = Token::Type::Fi;
  246. else if (token.value == "while"sv)
  247. token.type = Token::Type::While;
  248. else if (token.value == "until"sv)
  249. token.type = Token::Type::Until;
  250. else if (token.value == "do"sv)
  251. token.type = Token::Type::Do;
  252. else if (token.value == "done"sv)
  253. token.type = Token::Type::Done;
  254. else if (token.value == "case"sv)
  255. token.type = Token::Type::Case;
  256. else if (token.value == "esac"sv)
  257. token.type = Token::Type::Esac;
  258. else if (token.value == "for"sv)
  259. token.type = Token::Type::For;
  260. else if (token.value == "in"sv)
  261. token.type = Token::Type::In;
  262. else if (token.value == "!"sv)
  263. token.type = Token::Type::Bang;
  264. else if (token.value == "{"sv)
  265. token.type = Token::Type::OpenBrace;
  266. else if (token.value == "}"sv)
  267. token.type = Token::Type::CloseBrace;
  268. else if (token.type == Token::Type::Token)
  269. token.type = Token::Type::Word;
  270. } else if (token.type == Token::Type::Token) {
  271. token.type = Token::Type::Word;
  272. }
  273. };
  274. for (auto& token : tokens) {
  275. if (!previous_token.has_value()) {
  276. check_reserved_word(token);
  277. previous_token = token;
  278. continue;
  279. }
  280. if (!previous_previous_token.has_value()) {
  281. check_reserved_word(token);
  282. previous_previous_token = move(previous_token);
  283. previous_token = token;
  284. continue;
  285. }
  286. check_reserved_word(token);
  287. expanded_tokens.append(exchange(*previous_previous_token, exchange(*previous_token, move(token))));
  288. }
  289. swap_expansions();
  290. // (3) Detect io_number tokens
  291. previous_token = Optional<Token>();
  292. tokens_taken_from_buffer = 0;
  293. if (m_token_buffer.size() >= 1) {
  294. previous_token = m_token_buffer.take_last();
  295. tokens_taken_from_buffer++;
  296. }
  297. for (auto& token : tokens) {
  298. if (!previous_token.has_value()) {
  299. previous_token = token;
  300. continue;
  301. }
  302. if (is_io_operator(token) && previous_token->type == Token::Type::Word && all_of(previous_token->value.bytes_as_string_view(), is_ascii_digit)) {
  303. previous_token->type = Token::Type::IoNumber;
  304. }
  305. expanded_tokens.append(exchange(*previous_token, move(token)));
  306. }
  307. swap_expansions();
  308. // (4) Try to identify simple commands
  309. previous_token = Optional<Token>();
  310. tokens_taken_from_buffer = 0;
  311. if (m_token_buffer.size() >= 1) {
  312. previous_token = m_token_buffer.take_last();
  313. tokens_taken_from_buffer++;
  314. }
  315. for (auto& token : tokens) {
  316. if (!previous_token.has_value()) {
  317. token.could_be_start_of_a_simple_command = true;
  318. previous_token = token;
  319. continue;
  320. }
  321. token.could_be_start_of_a_simple_command = is_one_of(previous_token->type, Token::Type::OpenParen, Token::Type::CloseParen, Token::Type::Newline)
  322. || is_separator(*previous_token)
  323. || (!is_reserved(*previous_token) && is_reserved(token));
  324. expanded_tokens.append(exchange(*previous_token, move(token)));
  325. }
  326. swap_expansions();
  327. // (5) Detect assignment words
  328. for (auto& token : tokens) {
  329. if (token.could_be_start_of_a_simple_command)
  330. m_disallow_command_prefix = false;
  331. // Check if we're in a command prefix (could be an assignment)
  332. if (!m_disallow_command_prefix && token.type == Token::Type::Word && token.value.contains('=')) {
  333. // If the word before '=' is a valid name, this is an assignment
  334. auto equal_offset = *token.value.find_byte_offset('=');
  335. if (is_valid_name(token.value.bytes_as_string_view().substring_view(0, equal_offset)))
  336. token.type = Token::Type::AssignmentWord;
  337. else
  338. m_disallow_command_prefix = true;
  339. } else {
  340. m_disallow_command_prefix = true;
  341. }
  342. expanded_tokens.append(move(token));
  343. }
  344. swap_expansions();
  345. // (6) Parse expansions
  346. for (auto& token : tokens) {
  347. if (!is_one_of(token.type, Token::Type::Word, Token::Type::AssignmentWord)) {
  348. expanded_tokens.append(move(token));
  349. continue;
  350. }
  351. Vector<ResolvedExpansion> resolved_expansions;
  352. for (auto& expansion : token.expansions) {
  353. auto resolved = expansion.visit(
  354. [&](ParameterExpansion const& expansion) -> ResolvedExpansion {
  355. auto text = expansion.parameter.string_view();
  356. // ${NUMBER}
  357. if (all_of(text, is_ascii_digit)) {
  358. return ResolvedParameterExpansion {
  359. .parameter = expansion.parameter.to_string().release_value_but_fixme_should_propagate_errors(),
  360. .argument = {},
  361. .range = expansion.range,
  362. .op = ResolvedParameterExpansion::Op::GetPositionalParameter,
  363. .expand = ResolvedParameterExpansion::Expand::Word,
  364. };
  365. }
  366. if (text.length() == 1) {
  367. ResolvedParameterExpansion::Op op;
  368. switch (text[0]) {
  369. case '!':
  370. op = ResolvedParameterExpansion::Op::GetLastBackgroundPid;
  371. break;
  372. case '@':
  373. op = ResolvedParameterExpansion::Op::GetPositionalParameterList;
  374. break;
  375. case '-':
  376. op = ResolvedParameterExpansion::Op::GetCurrentOptionFlags;
  377. break;
  378. case '#':
  379. op = ResolvedParameterExpansion::Op::GetPositionalParameterCount;
  380. break;
  381. case '?':
  382. op = ResolvedParameterExpansion::Op::GetLastExitStatus;
  383. break;
  384. case '*':
  385. op = ResolvedParameterExpansion::Op::GetPositionalParameterListAsString;
  386. break;
  387. case '$':
  388. op = ResolvedParameterExpansion::Op::GetShellProcessId;
  389. break;
  390. default:
  391. if (is_valid_name(text)) {
  392. op = ResolvedParameterExpansion::Op::GetVariable;
  393. } else {
  394. error(token, "Unknown parameter expansion: {}", text);
  395. return ResolvedParameterExpansion {
  396. .parameter = expansion.parameter.to_string().release_value_but_fixme_should_propagate_errors(),
  397. .argument = {},
  398. .range = expansion.range,
  399. .op = ResolvedParameterExpansion::Op::StringLength,
  400. };
  401. }
  402. }
  403. return ResolvedParameterExpansion {
  404. .parameter = String::from_code_point(text[0]),
  405. .argument = {},
  406. .range = expansion.range,
  407. .op = op,
  408. .expand = ResolvedParameterExpansion::Expand::Word,
  409. };
  410. }
  411. if (text.starts_with('#')) {
  412. return ResolvedParameterExpansion {
  413. .parameter = String::from_utf8(text.substring_view(1)).release_value_but_fixme_should_propagate_errors(),
  414. .argument = {},
  415. .range = expansion.range,
  416. .op = ResolvedParameterExpansion::Op::StringLength,
  417. };
  418. }
  419. GenericLexer lexer { text };
  420. auto parameter = lexer.consume_while([first = true](char c) mutable {
  421. if (first) {
  422. first = false;
  423. return is_ascii_alpha(c) || c == '_';
  424. }
  425. return is_ascii_alphanumeric(c) || c == '_';
  426. });
  427. StringView argument;
  428. ResolvedParameterExpansion::Op op;
  429. switch (lexer.peek()) {
  430. case ':':
  431. lexer.ignore();
  432. switch (lexer.is_eof() ? 0 : lexer.consume()) {
  433. case '-':
  434. argument = lexer.consume_all();
  435. op = ResolvedParameterExpansion::Op::UseDefaultValue;
  436. break;
  437. case '=':
  438. argument = lexer.consume_all();
  439. op = ResolvedParameterExpansion::Op::AssignDefaultValue;
  440. break;
  441. case '?':
  442. argument = lexer.consume_all();
  443. op = ResolvedParameterExpansion::Op::IndicateErrorIfEmpty;
  444. break;
  445. case '+':
  446. argument = lexer.consume_all();
  447. op = ResolvedParameterExpansion::Op::UseAlternativeValue;
  448. break;
  449. default:
  450. error(token, "Unknown parameter expansion: {}", text);
  451. return ResolvedParameterExpansion {
  452. .parameter = String::from_utf8(parameter).release_value_but_fixme_should_propagate_errors(),
  453. .argument = {},
  454. .range = expansion.range,
  455. .op = ResolvedParameterExpansion::Op::StringLength,
  456. };
  457. }
  458. break;
  459. case '-':
  460. lexer.ignore();
  461. argument = lexer.consume_all();
  462. op = ResolvedParameterExpansion::Op::UseDefaultValueIfUnset;
  463. break;
  464. case '=':
  465. lexer.ignore();
  466. argument = lexer.consume_all();
  467. op = ResolvedParameterExpansion::Op::AssignDefaultValueIfUnset;
  468. break;
  469. case '?':
  470. lexer.ignore();
  471. argument = lexer.consume_all();
  472. op = ResolvedParameterExpansion::Op::IndicateErrorIfUnset;
  473. break;
  474. case '+':
  475. lexer.ignore();
  476. argument = lexer.consume_all();
  477. op = ResolvedParameterExpansion::Op::UseAlternativeValueIfUnset;
  478. break;
  479. case '%':
  480. if (lexer.consume_specific('%'))
  481. op = ResolvedParameterExpansion::Op::RemoveLargestSuffixByPattern;
  482. else
  483. op = ResolvedParameterExpansion::Op::RemoveSmallestSuffixByPattern;
  484. argument = lexer.consume_all();
  485. break;
  486. case '#':
  487. if (lexer.consume_specific('#'))
  488. op = ResolvedParameterExpansion::Op::RemoveLargestPrefixByPattern;
  489. else
  490. op = ResolvedParameterExpansion::Op::RemoveSmallestPrefixByPattern;
  491. argument = lexer.consume_all();
  492. break;
  493. default:
  494. if (is_valid_name(text)) {
  495. op = ResolvedParameterExpansion::Op::GetVariable;
  496. } else {
  497. error(token, "Unknown parameter expansion: {}", text);
  498. return ResolvedParameterExpansion {
  499. .parameter = String::from_utf8(parameter).release_value_but_fixme_should_propagate_errors(),
  500. .argument = {},
  501. .range = expansion.range,
  502. .op = ResolvedParameterExpansion::Op::StringLength,
  503. };
  504. }
  505. }
  506. VERIFY(lexer.is_eof());
  507. return ResolvedParameterExpansion {
  508. .parameter = String::from_utf8(parameter).release_value_but_fixme_should_propagate_errors(),
  509. .argument = String::from_utf8(argument).release_value_but_fixme_should_propagate_errors(),
  510. .range = expansion.range,
  511. .op = op,
  512. .expand = ResolvedParameterExpansion::Expand::Word,
  513. };
  514. },
  515. [&](ArithmeticExpansion const& expansion) -> ResolvedExpansion {
  516. return ResolvedArithmeticExpansion { expansion.expression, expansion.range };
  517. },
  518. [&](CommandExpansion const& expansion) -> ResolvedExpansion {
  519. Parser parser { expansion.command.string_view() };
  520. auto node = parser.parse();
  521. m_errors.extend(move(parser.m_errors));
  522. return ResolvedCommandExpansion {
  523. move(node),
  524. expansion.range,
  525. };
  526. });
  527. resolved_expansions.append(move(resolved));
  528. }
  529. token.resolved_expansions = move(resolved_expansions);
  530. expanded_tokens.append(move(token));
  531. }
  532. swap_expansions();
  533. // (7) Loop variables
  534. previous_token = {};
  535. tokens_taken_from_buffer = 0;
  536. if (m_token_buffer.size() >= 1) {
  537. previous_token = m_token_buffer.take_last();
  538. tokens_taken_from_buffer++;
  539. }
  540. for (auto& token : tokens) {
  541. if (!previous_token.has_value()) {
  542. previous_token = token;
  543. continue;
  544. }
  545. if (previous_token->type == Token::Type::For && token.type == Token::Type::Word && is_valid_name(token.value)) {
  546. token.type = Token::Type::VariableName;
  547. }
  548. expanded_tokens.append(exchange(*previous_token, token));
  549. }
  550. swap_expansions();
  551. // (8) Function names
  552. previous_token = {};
  553. previous_previous_token = {};
  554. tokens_taken_from_buffer = 0;
  555. if (m_token_buffer.size() >= 1) {
  556. previous_token = m_token_buffer.take_last();
  557. tokens_taken_from_buffer++;
  558. }
  559. if (m_token_buffer.size() >= 1) {
  560. previous_previous_token = m_token_buffer.take_last();
  561. tokens_taken_from_buffer++;
  562. }
  563. for (auto& token : tokens) {
  564. if (!previous_token.has_value()) {
  565. previous_token = token;
  566. continue;
  567. }
  568. if (!previous_previous_token.has_value()) {
  569. previous_previous_token = move(previous_token);
  570. previous_token = token;
  571. continue;
  572. }
  573. // NAME ( )
  574. if (previous_previous_token->could_be_start_of_a_simple_command
  575. && previous_previous_token->type == Token::Type::Word
  576. && previous_token->type == Token::Type::OpenParen
  577. && token.type == Token::Type::CloseParen) {
  578. previous_previous_token->type = Token::Type::VariableName;
  579. }
  580. expanded_tokens.append(exchange(*previous_previous_token, exchange(*previous_token, token)));
  581. }
  582. swap_expansions();
  583. return tokens;
  584. }
  585. ErrorOr<RefPtr<AST::Node>> Parser::parse_complete_command()
  586. {
  587. auto list = TRY([&]() -> ErrorOr<RefPtr<AST::Node>> {
  588. // separator...
  589. while (is_separator(peek()))
  590. skip();
  591. // list EOF
  592. auto list = TRY(parse_list());
  593. if (eof())
  594. return list;
  595. // list separator EOF
  596. while (is_separator(peek()))
  597. skip();
  598. if (eof())
  599. return list;
  600. auto position = peek().position;
  601. auto syntax_error = make_ref_counted<AST::SyntaxError>(
  602. position.value_or(empty_position()),
  603. "Extra tokens after complete command"_string);
  604. if (list)
  605. list->set_is_syntax_error(*syntax_error);
  606. else
  607. list = syntax_error;
  608. return list;
  609. }());
  610. if (!list)
  611. return nullptr;
  612. return make_ref_counted<AST::Execute>(list->position(), *list);
  613. }
  614. ErrorOr<RefPtr<AST::Node>> Parser::parse_list()
  615. {
  616. Vector<NonnullRefPtr<AST::Node>> nodes;
  617. Vector<AST::Position> positions;
  618. auto start_position = peek().position.value_or(empty_position());
  619. for (;;) {
  620. auto new_node = TRY(parse_and_or());
  621. if (!new_node)
  622. break;
  623. if (peek().type == Token::Type::And) {
  624. new_node = make_ref_counted<AST::Background>(
  625. new_node->position(),
  626. *new_node);
  627. }
  628. nodes.append(new_node.release_nonnull());
  629. if (!is_separator(peek()) || eof())
  630. break;
  631. auto position = consume().position;
  632. if (position.has_value())
  633. positions.append(position.release_value());
  634. }
  635. auto end_position = peek().position.value_or(empty_position());
  636. return make_ref_counted<AST::Sequence>(
  637. AST::Position {
  638. start_position.start_offset,
  639. end_position.end_offset,
  640. start_position.start_line,
  641. end_position.end_line,
  642. },
  643. move(nodes),
  644. move(positions));
  645. }
  646. ErrorOr<RefPtr<AST::Node>> Parser::parse_and_or()
  647. {
  648. while (peek().type == Token::Type::Newline)
  649. skip();
  650. auto node = TRY(parse_pipeline());
  651. if (!node)
  652. return RefPtr<AST::Node> {};
  653. for (;;) {
  654. if (peek().type == Token::Type::AndIf) {
  655. auto and_token = consume();
  656. while (peek().type == Token::Type::Newline)
  657. skip();
  658. auto rhs = TRY(parse_pipeline());
  659. if (!rhs)
  660. return RefPtr<AST::Node> {};
  661. node = make_ref_counted<AST::And>(
  662. node->position(),
  663. *node,
  664. rhs.release_nonnull(),
  665. and_token.position.value_or(empty_position()));
  666. continue;
  667. }
  668. if (peek().type == Token::Type::OrIf) {
  669. auto or_token = consume();
  670. while (peek().type == Token::Type::Newline)
  671. skip();
  672. auto rhs = TRY(parse_pipeline());
  673. if (!rhs)
  674. return RefPtr<AST::Node> {};
  675. node = make_ref_counted<AST::And>(
  676. node->position(),
  677. *node,
  678. rhs.release_nonnull(),
  679. or_token.position.value_or(empty_position()));
  680. continue;
  681. }
  682. break;
  683. }
  684. return node;
  685. }
  686. ErrorOr<RefPtr<AST::Node>> Parser::parse_pipeline()
  687. {
  688. while (peek().type == Token::Type::Newline)
  689. skip();
  690. auto is_negated = false;
  691. if (peek().type == Token::Type::Bang) {
  692. is_negated = true;
  693. skip();
  694. }
  695. return parse_pipe_sequence(is_negated);
  696. }
  697. ErrorOr<RefPtr<AST::Node>> Parser::parse_pipe_sequence(bool is_negated)
  698. {
  699. auto node = TRY(parse_command());
  700. if (!node)
  701. return RefPtr<AST::Node> {};
  702. if (is_negated) {
  703. if (is<AST::CastToCommand>(node.ptr())) {
  704. node = make_ref_counted<AST::CastToCommand>(
  705. node->position(),
  706. make_ref_counted<AST::ListConcatenate>(
  707. node->position(),
  708. Vector<NonnullRefPtr<AST::Node>> {
  709. make_ref_counted<AST::BarewordLiteral>(
  710. node->position(),
  711. "not"_string),
  712. *static_cast<AST::CastToCommand&>(*node).inner() }));
  713. }
  714. }
  715. for (;;) {
  716. if (peek().type != Token::Type::Pipe)
  717. break;
  718. consume();
  719. while (peek().type == Token::Type::Newline)
  720. skip();
  721. auto rhs = TRY(parse_command());
  722. if (!rhs)
  723. return RefPtr<AST::Node> {};
  724. node = make_ref_counted<AST::Pipe>(
  725. node->position(),
  726. *node,
  727. rhs.release_nonnull());
  728. }
  729. return node;
  730. }
  731. ErrorOr<RefPtr<AST::Node>> Parser::parse_command()
  732. {
  733. auto node = TRY([this]() -> ErrorOr<RefPtr<AST::Node>> {
  734. if (auto node = TRY(parse_function_definition()))
  735. return node;
  736. if (auto node = TRY(parse_simple_command()))
  737. return make_ref_counted<AST::CastToCommand>(node->position(), *node);
  738. auto node = TRY(parse_compound_command());
  739. if (!node)
  740. return node;
  741. if (auto list = TRY(parse_redirect_list())) {
  742. auto position = list->position();
  743. node = make_ref_counted<AST::Join>(
  744. node->position().with_end(position),
  745. *node,
  746. list.release_nonnull());
  747. }
  748. return node;
  749. }());
  750. if (!node)
  751. return nullptr;
  752. return node;
  753. }
  754. ErrorOr<RefPtr<AST::Node>> Parser::parse_function_definition()
  755. {
  756. // NAME OPEN_PAREN CLOSE_PAREN newline* function_body
  757. auto start_index = m_token_index;
  758. ArmedScopeGuard reset = [&] {
  759. m_token_index = start_index;
  760. };
  761. if (peek().type != Token::Type::VariableName) {
  762. return nullptr;
  763. }
  764. auto name = consume();
  765. if (consume().type != Token::Type::OpenParen)
  766. return nullptr;
  767. if (consume().type != Token::Type::CloseParen)
  768. return nullptr;
  769. while (peek().type == Token::Type::Newline)
  770. skip();
  771. auto body = TRY(parse_function_body());
  772. if (!body)
  773. return nullptr;
  774. reset.disarm();
  775. return make_ref_counted<AST::FunctionDeclaration>(
  776. name.position.value_or(empty_position()).with_end(peek().position.value_or(empty_position())),
  777. AST::NameWithPosition { TRY(String::from_utf8(name.value)), name.position.value_or(empty_position()) },
  778. Vector<AST::NameWithPosition> {},
  779. body.release_nonnull());
  780. }
  781. ErrorOr<RefPtr<AST::Node>> Parser::parse_function_body()
  782. {
  783. // compound_command redirect_list?
  784. auto node = TRY(parse_compound_command());
  785. if (!node)
  786. return nullptr;
  787. if (auto list = TRY(parse_redirect_list())) {
  788. auto position = list->position();
  789. node = make_ref_counted<AST::Join>(
  790. node->position().with_end(position),
  791. *node,
  792. list.release_nonnull());
  793. }
  794. return node;
  795. }
  796. ErrorOr<RefPtr<AST::Node>> Parser::parse_redirect_list()
  797. {
  798. // io_redirect*
  799. RefPtr<AST::Node> node;
  800. for (;;) {
  801. auto new_node = TRY(parse_io_redirect());
  802. if (!new_node)
  803. break;
  804. if (node) {
  805. node = make_ref_counted<AST::Join>(
  806. node->position().with_end(new_node->position()),
  807. *node,
  808. new_node.release_nonnull());
  809. } else {
  810. node = new_node;
  811. }
  812. }
  813. return node;
  814. }
  815. ErrorOr<RefPtr<AST::Node>> Parser::parse_compound_command()
  816. {
  817. if (auto node = TRY(parse_brace_group()))
  818. return node;
  819. if (auto node = TRY(parse_subshell()))
  820. return node;
  821. if (auto node = TRY(parse_if_clause()))
  822. return node;
  823. if (auto node = TRY(parse_for_clause()))
  824. return node;
  825. if (auto node = TRY(parse_case_clause()))
  826. return node;
  827. if (auto node = TRY(parse_while_clause()))
  828. return node;
  829. if (auto node = TRY(parse_until_clause()))
  830. return node;
  831. return nullptr;
  832. }
  833. ErrorOr<RefPtr<AST::Node>> Parser::parse_while_clause()
  834. {
  835. if (peek().type != Token::Type::While)
  836. return nullptr;
  837. auto start_position = consume().position.value_or(empty_position());
  838. auto condition = TRY(parse_compound_list());
  839. if (!condition)
  840. condition = make_ref_counted<AST::SyntaxError>(
  841. peek().position.value_or(empty_position()),
  842. "Expected condition after 'while'"_string);
  843. auto do_group = TRY(parse_do_group());
  844. if (!do_group)
  845. do_group = make_ref_counted<AST::SyntaxError>(
  846. peek().position.value_or(empty_position()),
  847. "Expected 'do' after 'while'"_string);
  848. // while foo; bar -> loop { if foo { bar } else { break } }
  849. auto position = start_position.with_end(peek().position.value_or(empty_position()));
  850. return make_ref_counted<AST::ForLoop>(
  851. position,
  852. Optional<AST::NameWithPosition> {},
  853. Optional<AST::NameWithPosition> {},
  854. nullptr,
  855. make_ref_counted<AST::Execute>(position,
  856. make_ref_counted<AST::IfCond>(
  857. position,
  858. Optional<AST::Position> {},
  859. condition.release_nonnull(),
  860. do_group.release_nonnull(),
  861. make_ref_counted<AST::ContinuationControl>(
  862. start_position,
  863. AST::ContinuationControl::ContinuationKind::Break))));
  864. }
  865. ErrorOr<RefPtr<AST::Node>> Parser::parse_until_clause()
  866. {
  867. if (peek().type != Token::Type::Until)
  868. return nullptr;
  869. auto start_position = consume().position.value_or(empty_position());
  870. auto condition = TRY(parse_compound_list());
  871. if (!condition)
  872. condition = make_ref_counted<AST::SyntaxError>(
  873. peek().position.value_or(empty_position()),
  874. "Expected condition after 'until'"_string);
  875. auto do_group = TRY(parse_do_group());
  876. if (!do_group)
  877. do_group = make_ref_counted<AST::SyntaxError>(
  878. peek().position.value_or(empty_position()),
  879. "Expected 'do' after 'until'"_string);
  880. // until foo; bar -> loop { if foo { break } else { bar } }
  881. auto position = start_position.with_end(peek().position.value_or(empty_position()));
  882. return make_ref_counted<AST::ForLoop>(
  883. position,
  884. Optional<AST::NameWithPosition> {},
  885. Optional<AST::NameWithPosition> {},
  886. nullptr,
  887. make_ref_counted<AST::Execute>(position,
  888. make_ref_counted<AST::IfCond>(
  889. position,
  890. Optional<AST::Position> {},
  891. condition.release_nonnull(),
  892. make_ref_counted<AST::ContinuationControl>(
  893. start_position,
  894. AST::ContinuationControl::ContinuationKind::Break),
  895. do_group.release_nonnull())));
  896. }
  897. ErrorOr<RefPtr<AST::Node>> Parser::parse_brace_group()
  898. {
  899. if (peek().type != Token::Type::OpenBrace)
  900. return nullptr;
  901. consume();
  902. auto list = TRY(parse_compound_list());
  903. RefPtr<AST::SyntaxError> error;
  904. if (peek().type != Token::Type::CloseBrace) {
  905. error = make_ref_counted<AST::SyntaxError>(
  906. peek().position.value_or(empty_position()),
  907. TRY(String::formatted("Expected '}}', not {}", peek().type_name())));
  908. } else {
  909. consume();
  910. }
  911. if (error) {
  912. if (list)
  913. list->set_is_syntax_error(*error);
  914. else
  915. list = error;
  916. }
  917. return make_ref_counted<AST::Execute>(list->position(), *list);
  918. }
  919. ErrorOr<RefPtr<AST::Node>> Parser::parse_case_clause()
  920. {
  921. auto start_position = peek().position.value_or(empty_position());
  922. if (peek().type != Token::Type::Case)
  923. return nullptr;
  924. skip();
  925. RefPtr<AST::SyntaxError> syntax_error;
  926. auto expr = TRY(parse_word());
  927. if (!expr)
  928. expr = make_ref_counted<AST::SyntaxError>(
  929. peek().position.value_or(empty_position()),
  930. TRY(String::formatted("Expected a word, not {}", peek().type_name())));
  931. if (peek().type != Token::Type::In) {
  932. syntax_error = make_ref_counted<AST::SyntaxError>(
  933. peek().position.value_or(empty_position()),
  934. TRY(String::formatted("Expected 'in', not {}", peek().type_name())));
  935. } else {
  936. skip();
  937. }
  938. while (peek().type == Token::Type::Newline)
  939. skip();
  940. Vector<AST::MatchEntry> entries;
  941. for (;;) {
  942. if (eof() || peek().type == Token::Type::Esac)
  943. break;
  944. if (peek().type == Token::Type::Newline) {
  945. skip();
  946. continue;
  947. }
  948. // Parse a pattern list
  949. auto needs_dsemi = true;
  950. if (peek().type == Token::Type::OpenParen) {
  951. skip();
  952. needs_dsemi = false;
  953. }
  954. auto result = TRY(parse_case_list());
  955. if (peek().type == Token::Type::CloseParen) {
  956. skip();
  957. } else {
  958. if (!syntax_error)
  959. syntax_error = make_ref_counted<AST::SyntaxError>(
  960. peek().position.value_or(empty_position()),
  961. TRY(String::formatted("Expected ')', not {}", peek().type_name())));
  962. break;
  963. }
  964. while (peek().type == Token::Type::Newline)
  965. skip();
  966. auto compound_list = TRY(parse_compound_list());
  967. if (peek().type == Token::Type::DoubleSemicolon) {
  968. skip();
  969. } else if (needs_dsemi) {
  970. if (!syntax_error)
  971. syntax_error = make_ref_counted<AST::SyntaxError>(
  972. peek().position.value_or(empty_position()),
  973. TRY(String::formatted("Expected ';;', not {}", peek().type_name())));
  974. }
  975. if (syntax_error) {
  976. if (compound_list)
  977. compound_list->set_is_syntax_error(*syntax_error);
  978. else
  979. compound_list = syntax_error;
  980. syntax_error = nullptr;
  981. }
  982. auto position = compound_list->position();
  983. entries.append(AST::MatchEntry {
  984. .options = move(result.nodes),
  985. .match_names = {},
  986. .match_as_position = {},
  987. .pipe_positions = move(result.pipe_positions),
  988. .body = make_ref_counted<AST::Execute>(position, compound_list.release_nonnull()),
  989. });
  990. }
  991. if (peek().type != Token::Type::Esac) {
  992. syntax_error = make_ref_counted<AST::SyntaxError>(
  993. peek().position.value_or(empty_position()),
  994. TRY(String::formatted("Expected 'esac', not {}", peek().type_name())));
  995. } else {
  996. skip();
  997. }
  998. auto node = make_ref_counted<AST::MatchExpr>(
  999. start_position.with_end(peek().position.value_or(empty_position())),
  1000. expr.release_nonnull(),
  1001. String {},
  1002. Optional<AST::Position> {},
  1003. move(entries));
  1004. if (syntax_error)
  1005. node->set_is_syntax_error(*syntax_error);
  1006. return node;
  1007. }
  1008. ErrorOr<Parser::CaseItemsResult> Parser::parse_case_list()
  1009. {
  1010. // Just a list of words split by '|', delimited by ')'
  1011. Vector<NonnullRefPtr<AST::Node>> nodes;
  1012. Vector<AST::Position> pipes;
  1013. for (;;) {
  1014. if (eof() || peek().type == Token::Type::CloseParen)
  1015. break;
  1016. if (peek().type != Token::Type::Word)
  1017. break;
  1018. auto node = TRY(parse_word());
  1019. if (!node)
  1020. node = make_ref_counted<AST::SyntaxError>(
  1021. peek().position.value_or(empty_position()),
  1022. TRY(String::formatted("Expected a word, not {}", peek().type_name())));
  1023. nodes.append(node.release_nonnull());
  1024. if (peek().type == Token::Type::Pipe) {
  1025. pipes.append(peek().position.value_or(empty_position()));
  1026. skip();
  1027. } else {
  1028. break;
  1029. }
  1030. }
  1031. if (nodes.is_empty())
  1032. nodes.append(make_ref_counted<AST::SyntaxError>(
  1033. peek().position.value_or(empty_position()),
  1034. TRY(String::formatted("Expected a word, not {}", peek().type_name()))));
  1035. return CaseItemsResult { move(pipes), move(nodes) };
  1036. }
  1037. ErrorOr<RefPtr<AST::Node>> Parser::parse_if_clause()
  1038. {
  1039. // If compound_list Then compound_list {Elif compound_list Then compound_list (Fi|Else)?} [(?=Else) compound_list] (?!=Fi) Fi
  1040. auto start_position = peek().position.value_or(empty_position());
  1041. if (peek().type != Token::Type::If)
  1042. return nullptr;
  1043. skip();
  1044. auto main_condition = TRY(parse_compound_list());
  1045. if (!main_condition)
  1046. main_condition = make_ref_counted<AST::SyntaxError>(empty_position(), "Expected compound list after 'if'"_string);
  1047. RefPtr<AST::SyntaxError> syntax_error;
  1048. if (peek().type != Token::Type::Then) {
  1049. syntax_error = make_ref_counted<AST::SyntaxError>(
  1050. peek().position.value_or(empty_position()),
  1051. TRY(String::formatted("Expected 'then', not {}", peek().type_name())));
  1052. } else {
  1053. skip();
  1054. }
  1055. auto main_consequence = TRY(parse_compound_list());
  1056. if (!main_consequence)
  1057. main_consequence = make_ref_counted<AST::SyntaxError>(empty_position(), "Expected compound list after 'then'"_string);
  1058. auto node = make_ref_counted<AST::IfCond>(start_position, Optional<AST::Position>(), main_condition.release_nonnull(), main_consequence.release_nonnull(), nullptr);
  1059. auto active_node = node;
  1060. while (peek().type == Token::Type::Elif) {
  1061. skip();
  1062. auto condition = TRY(parse_compound_list());
  1063. if (!condition)
  1064. condition = make_ref_counted<AST::SyntaxError>(empty_position(), "Expected compound list after 'elif'"_string);
  1065. if (peek().type != Token::Type::Then) {
  1066. if (!syntax_error)
  1067. syntax_error = make_ref_counted<AST::SyntaxError>(
  1068. peek().position.value_or(empty_position()),
  1069. TRY(String::formatted("Expected 'then', not {}", peek().type_name())));
  1070. } else {
  1071. skip();
  1072. }
  1073. auto consequence = TRY(parse_compound_list());
  1074. if (!consequence)
  1075. consequence = make_ref_counted<AST::SyntaxError>(empty_position(), "Expected compound list after 'then'"_string);
  1076. auto new_node = make_ref_counted<AST::IfCond>(start_position, Optional<AST::Position>(), condition.release_nonnull(), consequence.release_nonnull(), nullptr);
  1077. active_node->false_branch() = new_node;
  1078. active_node = move(new_node);
  1079. }
  1080. auto needs_fi = true;
  1081. switch (peek().type) {
  1082. case Token::Type::Else:
  1083. skip();
  1084. active_node->false_branch() = TRY(parse_compound_list());
  1085. if (!active_node->false_branch())
  1086. active_node->false_branch() = make_ref_counted<AST::SyntaxError>(empty_position(), "Expected compound list after 'else'"_string);
  1087. break;
  1088. case Token::Type::Fi:
  1089. skip();
  1090. needs_fi = false;
  1091. break;
  1092. default:
  1093. if (!syntax_error)
  1094. syntax_error = make_ref_counted<AST::SyntaxError>(
  1095. peek().position.value_or(empty_position()),
  1096. TRY(String::formatted("Expected 'else' or 'fi', not {}", peek().type_name())));
  1097. break;
  1098. }
  1099. if (needs_fi) {
  1100. if (peek().type != Token::Type::Fi) {
  1101. if (!syntax_error)
  1102. syntax_error = make_ref_counted<AST::SyntaxError>(
  1103. peek().position.value_or(empty_position()),
  1104. TRY(String::formatted("Expected 'fi', not {}", peek().type_name())));
  1105. } else {
  1106. skip();
  1107. }
  1108. }
  1109. if (syntax_error)
  1110. node->set_is_syntax_error(*syntax_error);
  1111. return node;
  1112. }
  1113. ErrorOr<RefPtr<AST::Node>> Parser::parse_subshell()
  1114. {
  1115. auto start_position = peek().position.value_or(empty_position());
  1116. if (peek().type != Token::Type::OpenParen)
  1117. return nullptr;
  1118. skip();
  1119. RefPtr<AST::SyntaxError> error;
  1120. auto list = TRY(parse_compound_list());
  1121. if (!list)
  1122. error = make_ref_counted<AST::SyntaxError>(peek().position.value_or(empty_position()), "Expected compound list after ("_string);
  1123. if (peek().type != Token::Type::CloseParen)
  1124. error = make_ref_counted<AST::SyntaxError>(peek().position.value_or(empty_position()), "Expected ) after compound list"_string);
  1125. else
  1126. skip();
  1127. if (!list)
  1128. return error;
  1129. return make_ref_counted<AST::Subshell>(
  1130. start_position.with_end(peek().position.value_or(empty_position())),
  1131. list.release_nonnull());
  1132. }
  1133. ErrorOr<RefPtr<AST::Node>> Parser::parse_compound_list()
  1134. {
  1135. while (peek().type == Token::Type::Newline)
  1136. skip();
  1137. auto term = TRY(parse_term());
  1138. if (!term)
  1139. return term;
  1140. if (is_separator(peek())) {
  1141. if (consume().type == Token::Type::And) {
  1142. term = make_ref_counted<AST::Background>(
  1143. term->position().with_end(peek().position.value_or(empty_position())),
  1144. *term);
  1145. }
  1146. }
  1147. return term;
  1148. }
  1149. ErrorOr<RefPtr<AST::Node>> Parser::parse_term()
  1150. {
  1151. Vector<NonnullRefPtr<AST::Node>> nodes;
  1152. Vector<AST::Position> positions;
  1153. auto start_position = peek().position.value_or(empty_position());
  1154. for (;;) {
  1155. auto new_node = TRY(parse_and_or());
  1156. if (!new_node)
  1157. break;
  1158. nodes.append(new_node.release_nonnull());
  1159. if (!is_separator(peek()))
  1160. break;
  1161. auto position = consume().position;
  1162. if (position.has_value())
  1163. positions.append(position.release_value());
  1164. }
  1165. auto end_position = peek().position.value_or(empty_position());
  1166. return make_ref_counted<AST::Sequence>(
  1167. start_position.with_end(end_position),
  1168. move(nodes),
  1169. move(positions));
  1170. }
  1171. ErrorOr<RefPtr<AST::Node>> Parser::parse_for_clause()
  1172. {
  1173. // FOR NAME newline+ do_group //-> FOR NAME IN "$@" newline+ do_group
  1174. // FOR NAME newline+ IN separator do_group
  1175. // FOR NAME IN separator do_group
  1176. // FOR NAME IN wordlist separator do_group
  1177. if (peek().type != Token::Type::For)
  1178. return nullptr;
  1179. auto start_position = consume().position.value_or(empty_position());
  1180. String name;
  1181. Optional<AST::Position> name_position;
  1182. if (peek().type == Token::Type::VariableName) {
  1183. name_position = peek().position;
  1184. name = consume().value;
  1185. } else {
  1186. name = "it"_string;
  1187. error(peek(), "Expected a variable name, not {}", peek().type_name());
  1188. }
  1189. auto saw_newline = false;
  1190. while (peek().type == Token::Type::Newline) {
  1191. saw_newline = true;
  1192. skip();
  1193. }
  1194. auto saw_in = false;
  1195. Optional<AST::Position> in_kw_position;
  1196. RefPtr<AST::Node> iterated_expression;
  1197. if (peek().type == Token::Type::In) {
  1198. saw_in = true;
  1199. in_kw_position = peek().position;
  1200. skip();
  1201. } else if (!saw_newline) {
  1202. error(peek(), "Expected 'in' or a newline, not {}", peek().type_name());
  1203. } else {
  1204. // FOR NAME newline+ do_group //-> FOR NAME IN "$@" newline+ do_group
  1205. iterated_expression = TRY(Parser { "\"$@\""_string }.parse_word());
  1206. }
  1207. if (saw_in && !saw_newline)
  1208. iterated_expression = parse_word_list();
  1209. if (saw_in) {
  1210. if (peek().type == Token::Type::Semicolon || peek().type == Token::Type::Newline)
  1211. skip();
  1212. else
  1213. error(peek(), "Expected a semicolon, not {}", peek().type_name());
  1214. }
  1215. while (peek().type == Token::Type::Newline)
  1216. skip();
  1217. auto body = TRY(parse_do_group());
  1218. return AST::make_ref_counted<AST::ForLoop>(
  1219. start_position.with_end(peek().position.value_or(empty_position())),
  1220. AST::NameWithPosition { name, name_position.value_or(empty_position()) },
  1221. Optional<AST::NameWithPosition> {},
  1222. move(iterated_expression),
  1223. move(body),
  1224. move(in_kw_position),
  1225. Optional<AST::Position> {});
  1226. }
  1227. RefPtr<AST::Node> Parser::parse_word_list(AllowNewlines allow_newlines)
  1228. {
  1229. Vector<NonnullRefPtr<AST::Node>> nodes;
  1230. auto start_position = peek().position.value_or(empty_position());
  1231. if (allow_newlines == AllowNewlines::Yes) {
  1232. while (peek().type == Token::Type::Newline)
  1233. skip();
  1234. }
  1235. for (; peek().type == Token::Type::Word;) {
  1236. auto word = TRY_OR_THROW_PARSE_ERROR_AT(parse_word(), start_position);
  1237. nodes.append(word.release_nonnull());
  1238. if (allow_newlines == AllowNewlines::Yes) {
  1239. while (peek().type == Token::Type::Newline)
  1240. skip();
  1241. }
  1242. }
  1243. return make_ref_counted<AST::ListConcatenate>(
  1244. start_position.with_end(peek().position.value_or(empty_position())),
  1245. move(nodes));
  1246. }
  1247. ErrorOr<RefPtr<AST::Node>> Parser::parse_word()
  1248. {
  1249. if (peek().type != Token::Type::Word)
  1250. return nullptr;
  1251. auto token = consume();
  1252. RefPtr<AST::Node> word;
  1253. enum class Quote {
  1254. None,
  1255. Single,
  1256. Double,
  1257. } in_quote { Quote::None };
  1258. auto append_bareword = [&](StringView string) -> ErrorOr<void> {
  1259. if (!word && string.starts_with('~')) {
  1260. GenericLexer lexer { string };
  1261. lexer.ignore();
  1262. auto user = lexer.consume_while(is_ascii_alphanumeric);
  1263. string = lexer.remaining();
  1264. word = make_ref_counted<AST::Tilde>(token.position.value_or(empty_position()), TRY(String::from_utf8(user)));
  1265. }
  1266. if (string.is_empty())
  1267. return {};
  1268. auto node = make_ref_counted<AST::BarewordLiteral>(
  1269. token.position.value_or(empty_position()),
  1270. TRY(String::from_utf8(string)));
  1271. if (word) {
  1272. word = make_ref_counted<AST::Juxtaposition>(
  1273. word->position().with_end(token.position.value_or(empty_position())),
  1274. *word,
  1275. move(node),
  1276. AST::Juxtaposition::Mode::StringExpand);
  1277. } else {
  1278. word = move(node);
  1279. }
  1280. return {};
  1281. };
  1282. auto append_string_literal = [&](StringView string) -> ErrorOr<void> {
  1283. auto node = make_ref_counted<AST::StringLiteral>(
  1284. token.position.value_or(empty_position()),
  1285. TRY(String::from_utf8(string)),
  1286. AST::StringLiteral::EnclosureType::SingleQuotes);
  1287. if (word) {
  1288. word = make_ref_counted<AST::Juxtaposition>(
  1289. word->position().with_end(token.position.value_or(empty_position())),
  1290. *word,
  1291. move(node),
  1292. AST::Juxtaposition::Mode::StringExpand);
  1293. } else {
  1294. word = move(node);
  1295. }
  1296. return {};
  1297. };
  1298. auto append_string_part = [&](StringView string) -> ErrorOr<void> {
  1299. auto node = make_ref_counted<AST::StringLiteral>(
  1300. token.position.value_or(empty_position()),
  1301. TRY(String::from_utf8(string)),
  1302. AST::StringLiteral::EnclosureType::DoubleQuotes);
  1303. if (word) {
  1304. word = make_ref_counted<AST::Juxtaposition>(
  1305. word->position().with_end(token.position.value_or(empty_position())),
  1306. *word,
  1307. move(node),
  1308. AST::Juxtaposition::Mode::StringExpand);
  1309. } else {
  1310. word = move(node);
  1311. }
  1312. return {};
  1313. };
  1314. auto append_arithmetic_expansion = [&](ResolvedArithmeticExpansion const& x) -> ErrorOr<void> {
  1315. auto node = make_ref_counted<AST::ImmediateExpression>(
  1316. token.position.value_or(empty_position()),
  1317. AST::NameWithPosition {
  1318. "math"_string,
  1319. token.position.value_or(empty_position()),
  1320. },
  1321. Vector<NonnullRefPtr<AST::Node>> {
  1322. make_ref_counted<AST::ImmediateExpression>(
  1323. token.position.value_or(empty_position()),
  1324. AST::NameWithPosition {
  1325. "reexpand"_string,
  1326. token.position.value_or(empty_position()),
  1327. },
  1328. Vector<NonnullRefPtr<AST::Node>> {
  1329. make_ref_counted<AST::StringLiteral>(
  1330. token.position.value_or(empty_position()),
  1331. TRY(String::from_utf8(x.source_expression)),
  1332. AST::StringLiteral::EnclosureType::DoubleQuotes),
  1333. },
  1334. Optional<AST::Position> {}) },
  1335. Optional<AST::Position> {});
  1336. if (word) {
  1337. word = make_ref_counted<AST::Juxtaposition>(
  1338. word->position().with_end(token.position.value_or(empty_position())),
  1339. *word,
  1340. move(node),
  1341. AST::Juxtaposition::Mode::StringExpand);
  1342. } else {
  1343. word = move(node);
  1344. }
  1345. return {};
  1346. };
  1347. auto append_parameter_expansion = [&](ResolvedParameterExpansion const& x) -> ErrorOr<void> {
  1348. StringView immediate_function_name;
  1349. RefPtr<AST::Node> node;
  1350. switch (x.op) {
  1351. case ResolvedParameterExpansion::Op::UseDefaultValue:
  1352. immediate_function_name = "value_or_default"sv;
  1353. break;
  1354. case ResolvedParameterExpansion::Op::AssignDefaultValue:
  1355. immediate_function_name = "assign_default"sv;
  1356. break;
  1357. case ResolvedParameterExpansion::Op::IndicateErrorIfEmpty:
  1358. immediate_function_name = "error_if_empty"sv;
  1359. break;
  1360. case ResolvedParameterExpansion::Op::UseAlternativeValue:
  1361. immediate_function_name = "null_or_alternative"sv;
  1362. break;
  1363. case ResolvedParameterExpansion::Op::UseDefaultValueIfUnset:
  1364. immediate_function_name = "defined_value_or_default"sv;
  1365. break;
  1366. case ResolvedParameterExpansion::Op::AssignDefaultValueIfUnset:
  1367. immediate_function_name = "assign_defined_default"sv;
  1368. break;
  1369. case ResolvedParameterExpansion::Op::IndicateErrorIfUnset:
  1370. immediate_function_name = "error_if_unset"sv;
  1371. break;
  1372. case ResolvedParameterExpansion::Op::UseAlternativeValueIfUnset:
  1373. immediate_function_name = "null_if_unset_or_alternative"sv;
  1374. break;
  1375. case ResolvedParameterExpansion::Op::RemoveLargestSuffixByPattern:
  1376. // FIXME: Implement this
  1377. case ResolvedParameterExpansion::Op::RemoveSmallestSuffixByPattern:
  1378. immediate_function_name = "remove_suffix"sv;
  1379. break;
  1380. case ResolvedParameterExpansion::Op::RemoveLargestPrefixByPattern:
  1381. // FIXME: Implement this
  1382. case ResolvedParameterExpansion::Op::RemoveSmallestPrefixByPattern:
  1383. immediate_function_name = "remove_prefix"sv;
  1384. break;
  1385. case ResolvedParameterExpansion::Op::StringLength:
  1386. immediate_function_name = "length_of_variable"sv;
  1387. break;
  1388. case ResolvedParameterExpansion::Op::GetPositionalParameter:
  1389. case ResolvedParameterExpansion::Op::GetVariable:
  1390. node = make_ref_counted<AST::SimpleVariable>(
  1391. token.position.value_or(empty_position()),
  1392. x.parameter);
  1393. break;
  1394. case ResolvedParameterExpansion::Op::GetLastBackgroundPid:
  1395. node = make_ref_counted<AST::SyntaxError>(
  1396. token.position.value_or(empty_position()),
  1397. "$! not implemented"_string);
  1398. break;
  1399. case ResolvedParameterExpansion::Op::GetPositionalParameterList:
  1400. node = make_ref_counted<AST::SpecialVariable>(
  1401. token.position.value_or(empty_position()),
  1402. '*');
  1403. break;
  1404. case ResolvedParameterExpansion::Op::GetCurrentOptionFlags:
  1405. node = make_ref_counted<AST::SyntaxError>(
  1406. token.position.value_or(empty_position()),
  1407. "The current option flags are not available in parameter expansions"_string);
  1408. break;
  1409. case ResolvedParameterExpansion::Op::GetPositionalParameterCount:
  1410. node = make_ref_counted<AST::SpecialVariable>(
  1411. token.position.value_or(empty_position()),
  1412. '#');
  1413. break;
  1414. case ResolvedParameterExpansion::Op::GetLastExitStatus:
  1415. node = make_ref_counted<AST::SpecialVariable>(
  1416. token.position.value_or(empty_position()),
  1417. '?');
  1418. break;
  1419. case ResolvedParameterExpansion::Op::GetPositionalParameterListAsString:
  1420. node = strip_execute(::Shell::Parser { "${join \"${defined_value_or_default IFS ' '}\" $*}"sv }.parse());
  1421. break;
  1422. case ResolvedParameterExpansion::Op::GetShellProcessId:
  1423. node = make_ref_counted<AST::SpecialVariable>(
  1424. token.position.value_or(empty_position()),
  1425. '$');
  1426. break;
  1427. }
  1428. if (!node) {
  1429. Vector<NonnullRefPtr<AST::Node>> arguments;
  1430. arguments.append(make_ref_counted<AST::BarewordLiteral>(
  1431. token.position.value_or(empty_position()),
  1432. x.parameter));
  1433. if (!x.argument.is_empty()) {
  1434. // dbgln("Will parse {}", x.argument);
  1435. arguments.append(*TRY(Parser { x.argument }.parse_word()));
  1436. }
  1437. node = make_ref_counted<AST::ImmediateExpression>(
  1438. token.position.value_or(empty_position()),
  1439. AST::NameWithPosition {
  1440. TRY(String::from_utf8(immediate_function_name)),
  1441. token.position.value_or(empty_position()),
  1442. },
  1443. move(arguments),
  1444. Optional<AST::Position> {});
  1445. }
  1446. if (x.expand == ResolvedParameterExpansion::Expand::Word) {
  1447. node = make_ref_counted<AST::ImmediateExpression>(
  1448. token.position.value_or(empty_position()),
  1449. AST::NameWithPosition {
  1450. "reexpand"_string,
  1451. token.position.value_or(empty_position()),
  1452. },
  1453. Vector { node.release_nonnull() },
  1454. Optional<AST::Position> {});
  1455. }
  1456. if (word) {
  1457. word = make_ref_counted<AST::Juxtaposition>(
  1458. word->position().with_end(token.position.value_or(empty_position())),
  1459. *word,
  1460. node.release_nonnull(),
  1461. AST::Juxtaposition::Mode::StringExpand);
  1462. } else {
  1463. word = move(node);
  1464. }
  1465. return {};
  1466. };
  1467. auto append_command_expansion = [&](ResolvedCommandExpansion const& x) -> ErrorOr<void> {
  1468. if (!x.command)
  1469. return {};
  1470. RefPtr<AST::Execute> execute_node;
  1471. if (x.command->is_execute()) {
  1472. execute_node = const_cast<AST::Execute&>(static_cast<AST::Execute const&>(*x.command));
  1473. execute_node->capture_stdout();
  1474. } else {
  1475. execute_node = make_ref_counted<AST::Execute>(
  1476. word ? word->position() : empty_position(),
  1477. *x.command,
  1478. true);
  1479. }
  1480. if (word) {
  1481. word = make_ref_counted<AST::Juxtaposition>(
  1482. word->position(),
  1483. *word,
  1484. execute_node.release_nonnull(),
  1485. AST::Juxtaposition::Mode::StringExpand);
  1486. } else {
  1487. word = move(execute_node);
  1488. }
  1489. return {};
  1490. };
  1491. auto append_string = [&](StringView string) -> ErrorOr<void> {
  1492. if (string.is_empty())
  1493. return {};
  1494. Optional<size_t> run_start;
  1495. auto escape = false;
  1496. for (size_t i = 0; i < string.length(); ++i) {
  1497. auto ch = string[i];
  1498. switch (ch) {
  1499. case '\\':
  1500. if (!escape && i + 1 < string.length()) {
  1501. if (run_start.has_value())
  1502. TRY(append_string_literal(string.substring_view(*run_start, i - *run_start)));
  1503. run_start = i + 1;
  1504. if (is_one_of(string[i + 1], '"', '\'', '$', '`', '\\')) {
  1505. escape = in_quote != Quote::Single;
  1506. continue;
  1507. }
  1508. }
  1509. break;
  1510. case '\'':
  1511. if (in_quote == Quote::Single) {
  1512. in_quote = Quote::None;
  1513. if (run_start.has_value())
  1514. TRY(append_string_literal(string.substring_view(*run_start, i - *run_start)));
  1515. run_start = i + 1;
  1516. continue;
  1517. }
  1518. if (in_quote == Quote::Double) {
  1519. escape = false;
  1520. continue;
  1521. }
  1522. [[fallthrough]];
  1523. case '"':
  1524. if (ch == '\'' && in_quote == Quote::Single) {
  1525. escape = false;
  1526. continue;
  1527. }
  1528. if (!escape) {
  1529. if (ch == '"' && in_quote == Quote::Double) {
  1530. in_quote = Quote::None;
  1531. if (run_start.has_value())
  1532. TRY(append_string_part(string.substring_view(*run_start, i - *run_start)));
  1533. run_start = i + 1;
  1534. continue;
  1535. }
  1536. if (run_start.has_value())
  1537. TRY(append_bareword(string.substring_view(*run_start, i - *run_start)));
  1538. in_quote = ch == '\'' ? Quote::Single : Quote::Double;
  1539. run_start = i + 1;
  1540. }
  1541. escape = false;
  1542. [[fallthrough]];
  1543. default:
  1544. if (!run_start.has_value())
  1545. run_start = i;
  1546. escape = false;
  1547. continue;
  1548. }
  1549. }
  1550. if (run_start.has_value())
  1551. TRY(append_bareword(string.substring_view(*run_start, string.length() - *run_start)));
  1552. return {};
  1553. };
  1554. if (!token.resolved_expansions.is_empty())
  1555. dbgln_if(SHELL_POSIX_PARSER_DEBUG, "Expanding '{}' with {} expansion entries", token.value, token.resolved_expansions.size());
  1556. size_t current_offset = 0;
  1557. auto value_bytes = token.value.bytes_as_string_view();
  1558. for (auto& expansion : token.resolved_expansions) {
  1559. TRY(expansion.visit(
  1560. [&](ResolvedParameterExpansion const& x) -> ErrorOr<void> {
  1561. dbgln_if(SHELL_POSIX_PARSER_DEBUG, " Expanding '{}' ({}+{})", x.to_deprecated_string(), x.range.start, x.range.length);
  1562. if (x.range.start >= value_bytes.length()) {
  1563. dbgln("Parameter expansion range {}-{} is out of bounds for '{}'", x.range.start, x.range.length, value_bytes);
  1564. return {};
  1565. }
  1566. if (x.range.start != current_offset) {
  1567. TRY(append_string(value_bytes.substring_view(current_offset, x.range.start - current_offset)));
  1568. current_offset = x.range.start;
  1569. }
  1570. current_offset += x.range.length;
  1571. return append_parameter_expansion(x);
  1572. },
  1573. [&](ResolvedArithmeticExpansion const& x) -> ErrorOr<void> {
  1574. if (x.range.start >= value_bytes.length()) {
  1575. dbgln("Parameter expansion range {}-{} is out of bounds for '{}'", x.range.start, x.range.length, value_bytes);
  1576. return {};
  1577. }
  1578. if (x.range.start != current_offset) {
  1579. TRY(append_string(value_bytes.substring_view(current_offset, x.range.start - current_offset)));
  1580. current_offset = x.range.start;
  1581. }
  1582. current_offset += x.range.length;
  1583. return append_arithmetic_expansion(x);
  1584. },
  1585. [&](ResolvedCommandExpansion const& x) -> ErrorOr<void> {
  1586. if (x.range.start >= value_bytes.length()) {
  1587. dbgln("Parameter expansion range {}-{} is out of bounds for '{}'", x.range.start, x.range.length, value_bytes);
  1588. return {};
  1589. }
  1590. if (x.range.start != current_offset) {
  1591. TRY(append_string(value_bytes.substring_view(current_offset, x.range.start - current_offset)));
  1592. current_offset = x.range.start;
  1593. }
  1594. current_offset += x.range.length;
  1595. return append_command_expansion(x);
  1596. }));
  1597. }
  1598. if (current_offset > value_bytes.length()) {
  1599. dbgln("Parameter expansion range {}- is out of bounds for '{}'", current_offset, value_bytes);
  1600. return word;
  1601. }
  1602. if (current_offset != value_bytes.length())
  1603. TRY(append_string(value_bytes.substring_view(current_offset)));
  1604. return word;
  1605. }
  1606. ErrorOr<RefPtr<AST::Node>> Parser::parse_bash_like_list()
  1607. {
  1608. if (peek().type != Token::Type::OpenParen)
  1609. return nullptr;
  1610. auto start_position = peek().position.value_or(empty_position());
  1611. consume();
  1612. auto list = parse_word_list(AllowNewlines::Yes);
  1613. if (peek().type != Token::Type::CloseParen) {
  1614. return make_ref_counted<AST::SyntaxError>(
  1615. peek().position.value_or(empty_position()),
  1616. TRY(String::formatted("Expected ')', not {}", peek().type_name())));
  1617. }
  1618. consume();
  1619. if (list)
  1620. list->position() = start_position.with_end(peek().position.value_or(empty_position()));
  1621. else
  1622. list = make_ref_counted<AST::ListConcatenate>(start_position.with_end(peek().position.value_or(empty_position())), Vector<NonnullRefPtr<AST::Node>> {});
  1623. return list;
  1624. }
  1625. ErrorOr<RefPtr<AST::Node>> Parser::parse_do_group()
  1626. {
  1627. if (peek().type != Token::Type::Do) {
  1628. return make_ref_counted<AST::SyntaxError>(
  1629. peek().position.value_or(empty_position()),
  1630. TRY(String::formatted("Expected 'do', not {}", peek().type_name())));
  1631. }
  1632. consume();
  1633. auto list = TRY(parse_compound_list());
  1634. RefPtr<AST::SyntaxError> error;
  1635. if (peek().type != Token::Type::Done) {
  1636. error = make_ref_counted<AST::SyntaxError>(
  1637. peek().position.value_or(empty_position()),
  1638. TRY(String::formatted("Expected 'done', not {}", peek().type_name())));
  1639. } else {
  1640. consume();
  1641. }
  1642. if (error) {
  1643. if (list)
  1644. list->set_is_syntax_error(*error);
  1645. else
  1646. list = error;
  1647. }
  1648. return make_ref_counted<AST::Execute>(list->position(), *list);
  1649. }
  1650. ErrorOr<RefPtr<AST::Node>> Parser::parse_simple_command()
  1651. {
  1652. auto start_position = peek().position.value_or(empty_position());
  1653. Vector<String> definitions;
  1654. HashMap<String, NonnullRefPtr<AST::Node>> list_assignments;
  1655. Vector<NonnullRefPtr<AST::Node>> nodes;
  1656. for (;;) {
  1657. if (auto io_redirect = TRY(parse_io_redirect()))
  1658. nodes.append(*io_redirect);
  1659. else
  1660. break;
  1661. }
  1662. while (is_one_of(peek().type, Token::Type::ListAssignmentWord, Token::Type::AssignmentWord)) {
  1663. if (peek().type == Token::Type::ListAssignmentWord) {
  1664. auto token = consume();
  1665. auto value = TRY(parse_bash_like_list());
  1666. if (!value)
  1667. return make_ref_counted<AST::SyntaxError>(
  1668. token.position.value_or(empty_position()),
  1669. TRY(String::formatted("Expected a list literal after '{}', not {}", token.value, peek().type_name())));
  1670. list_assignments.set(token.value, value.release_nonnull());
  1671. continue;
  1672. }
  1673. definitions.append(peek().value);
  1674. if (nodes.is_empty()) {
  1675. // run_with_env -e*(assignments) -- (command)
  1676. nodes.append(make_ref_counted<AST::BarewordLiteral>(
  1677. empty_position(),
  1678. "run_with_env"_string));
  1679. }
  1680. auto position = peek().position.value_or(empty_position());
  1681. nodes.append(make_ref_counted<AST::ImmediateExpression>(
  1682. position,
  1683. AST::NameWithPosition {
  1684. "reexpand"_string,
  1685. position,
  1686. },
  1687. Vector<NonnullRefPtr<AST::Node>> {
  1688. make_ref_counted<AST::StringLiteral>(
  1689. position,
  1690. TRY(String::formatted("-e{}", consume().value)),
  1691. AST::StringLiteral::EnclosureType::DoubleQuotes),
  1692. },
  1693. Optional<AST::Position> {}));
  1694. }
  1695. if (!definitions.is_empty()) {
  1696. nodes.append(make_ref_counted<AST::BarewordLiteral>(
  1697. empty_position(),
  1698. "--"_string));
  1699. }
  1700. // WORD or io_redirect: IO_NUMBER or io_file
  1701. if (!is_one_of(peek().type,
  1702. Token::Type::Word, Token::Type::IoNumber,
  1703. Token::Type::Less, Token::Type::LessAnd, Token::Type::Great, Token::Type::GreatAnd,
  1704. Token::Type::DoubleGreat, Token::Type::LessGreat, Token::Type::Clobber)) {
  1705. if (!definitions.is_empty() || !list_assignments.is_empty()) {
  1706. Vector<AST::VariableDeclarations::Variable> variables;
  1707. for (auto& definition : definitions) {
  1708. auto equal_offset = definition.find_byte_offset('=');
  1709. auto split_offset = equal_offset.value_or(definition.bytes().size());
  1710. auto name = make_ref_counted<AST::BarewordLiteral>(
  1711. empty_position(),
  1712. TRY(definition.substring_from_byte_offset_with_shared_superstring(0, split_offset)));
  1713. auto position = peek().position.value_or(empty_position());
  1714. auto expanded_value = make_ref_counted<AST::ImmediateExpression>(
  1715. position,
  1716. AST::NameWithPosition {
  1717. "reexpand"_string,
  1718. position,
  1719. },
  1720. Vector<NonnullRefPtr<AST::Node>> {
  1721. make_ref_counted<AST::StringLiteral>(
  1722. position,
  1723. TRY(definition.substring_from_byte_offset_with_shared_superstring(split_offset + 1)),
  1724. AST::StringLiteral::EnclosureType::DoubleQuotes),
  1725. },
  1726. Optional<AST::Position> {});
  1727. variables.append({ move(name), move(expanded_value) });
  1728. }
  1729. for (auto& [key, value] : list_assignments) {
  1730. auto equal_offset = key.find_byte_offset('=');
  1731. auto split_offset = equal_offset.value_or(key.bytes().size());
  1732. auto name = make_ref_counted<AST::BarewordLiteral>(
  1733. empty_position(),
  1734. TRY(key.substring_from_byte_offset_with_shared_superstring(0, split_offset)));
  1735. variables.append({ move(name), move(value) });
  1736. }
  1737. return make_ref_counted<AST::VariableDeclarations>(empty_position(), move(variables));
  1738. }
  1739. return nullptr;
  1740. }
  1741. if (!list_assignments.is_empty()) {
  1742. return make_ref_counted<AST::SyntaxError>(
  1743. peek().position.value_or(empty_position()),
  1744. "List assignments are not allowed as a command prefix"_string);
  1745. }
  1746. // auto first = true;
  1747. for (;;) {
  1748. if (peek().type == Token::Type::Word) {
  1749. auto new_word = TRY(parse_word());
  1750. if (!new_word)
  1751. break;
  1752. // if (first) {
  1753. // first = false;
  1754. // new_word = make_ref_counted<AST::ImmediateExpression>(
  1755. // new_word->position(),
  1756. // AST::NameWithPosition {
  1757. // "substitute_aliases"sv,
  1758. // empty_position(),
  1759. // },
  1760. // Vector<NonnullRefPtr<AST::Node>> { *new_word },
  1761. // Optional<AST::Position> {});
  1762. // }
  1763. nodes.append(new_word.release_nonnull());
  1764. } else if (auto io_redirect = TRY(parse_io_redirect())) {
  1765. nodes.append(io_redirect.release_nonnull());
  1766. } else {
  1767. break;
  1768. }
  1769. }
  1770. auto node = make_ref_counted<AST::ListConcatenate>(
  1771. start_position.with_end(peek().position.value_or(empty_position())),
  1772. move(nodes));
  1773. return node;
  1774. }
  1775. ErrorOr<RefPtr<AST::Node>> Parser::parse_io_redirect()
  1776. {
  1777. auto start_position = peek().position.value_or(empty_position());
  1778. auto start_index = m_token_index;
  1779. // io_redirect: IO_NUMBER? io_file | IO_NUMBER? io_here
  1780. Optional<int> io_number;
  1781. if (peek().type == Token::Type::IoNumber)
  1782. io_number = consume().value.bytes_as_string_view().to_int();
  1783. if (auto io_file = TRY(parse_io_file(start_position, io_number)))
  1784. return io_file;
  1785. if (auto io_here = TRY(parse_io_here(start_position, io_number)))
  1786. return io_here;
  1787. m_token_index = start_index;
  1788. return nullptr;
  1789. }
  1790. ErrorOr<RefPtr<AST::Node>> Parser::parse_io_here(AST::Position start_position, Optional<int> fd)
  1791. {
  1792. // io_here: IO_NUMBER? (DLESS | DLESSDASH) WORD
  1793. auto io_operator = peek().type;
  1794. if (!is_one_of(io_operator, Token::Type::DoubleLess, Token::Type::DoubleLessDash))
  1795. return nullptr;
  1796. auto io_operator_token = consume();
  1797. auto redirection_fd = fd.value_or(0);
  1798. auto end_keyword = consume();
  1799. if (!is_one_of(end_keyword.type, Token::Type::Word, Token::Type::Token))
  1800. return make_ref_counted<AST::SyntaxError>(io_operator_token.position.value_or(start_position), "Expected a heredoc keyword"_string, true);
  1801. auto [end_keyword_text, allow_interpolation] = Lexer::process_heredoc_key(end_keyword);
  1802. RefPtr<AST::SyntaxError> error;
  1803. auto position = start_position.with_end(peek().position.value_or(empty_position()));
  1804. auto result = make_ref_counted<AST::Heredoc>(
  1805. position,
  1806. end_keyword_text,
  1807. allow_interpolation,
  1808. io_operator == Token::Type::DoubleLessDash,
  1809. Optional<int> { redirection_fd });
  1810. m_unprocessed_heredoc_entries.set(end_keyword_text, result);
  1811. if (error)
  1812. result->set_is_syntax_error(*error);
  1813. return result;
  1814. }
  1815. ErrorOr<RefPtr<AST::Node>> Parser::parse_io_file(AST::Position start_position, Optional<int> fd)
  1816. {
  1817. auto start_index = m_token_index;
  1818. // io_file = (LESS | LESSAND | GREAT | GREATAND | DGREAT | LESSGREAT | CLOBBER) WORD
  1819. auto io_operator = peek().type;
  1820. if (!is_one_of(io_operator,
  1821. Token::Type::Less, Token::Type::LessAnd, Token::Type::Great, Token::Type::GreatAnd,
  1822. Token::Type::DoubleGreat, Token::Type::LessGreat, Token::Type::Clobber))
  1823. return nullptr;
  1824. auto io_operator_token = consume();
  1825. RefPtr<AST::Node> word;
  1826. if (peek().type == Token::Type::IoNumber) {
  1827. auto token = consume();
  1828. word = make_ref_counted<AST::BarewordLiteral>(
  1829. token.position.value_or(empty_position()),
  1830. token.value);
  1831. } else {
  1832. word = TRY(parse_word());
  1833. }
  1834. if (!word) {
  1835. m_token_index = start_index;
  1836. return nullptr;
  1837. }
  1838. auto position = start_position.with_end(peek().position.value_or(empty_position()));
  1839. switch (io_operator) {
  1840. case Token::Type::Less:
  1841. return make_ref_counted<AST::ReadRedirection>(
  1842. position,
  1843. fd.value_or(0),
  1844. word.release_nonnull());
  1845. case Token::Type::Clobber:
  1846. // FIXME: Add support for clobber (and 'noclobber')
  1847. case Token::Type::Great:
  1848. return make_ref_counted<AST::WriteRedirection>(
  1849. position,
  1850. fd.value_or(1),
  1851. word.release_nonnull());
  1852. case Token::Type::DoubleGreat:
  1853. return make_ref_counted<AST::WriteAppendRedirection>(
  1854. position,
  1855. fd.value_or(1),
  1856. word.release_nonnull());
  1857. case Token::Type::LessGreat:
  1858. return make_ref_counted<AST::ReadWriteRedirection>(
  1859. position,
  1860. fd.value_or(0),
  1861. word.release_nonnull());
  1862. case Token::Type::LessAnd:
  1863. case Token::Type::GreatAnd: {
  1864. auto is_less = io_operator == Token::Type::LessAnd;
  1865. auto source_fd = fd.value_or(is_less ? 0 : 1);
  1866. if (word->is_bareword()) {
  1867. auto text = static_ptr_cast<AST::BarewordLiteral>(word)->text();
  1868. if (!is_less && text == "-"sv) {
  1869. return make_ref_counted<AST::CloseFdRedirection>(
  1870. position,
  1871. source_fd);
  1872. }
  1873. auto maybe_target_fd = text.bytes_as_string_view().to_int();
  1874. if (maybe_target_fd.has_value()) {
  1875. auto target_fd = maybe_target_fd.release_value();
  1876. if (is_less)
  1877. swap(source_fd, target_fd);
  1878. return make_ref_counted<AST::Fd2FdRedirection>(
  1879. position,
  1880. source_fd,
  1881. target_fd);
  1882. }
  1883. }
  1884. if (is_less) {
  1885. return make_ref_counted<AST::ReadRedirection>(
  1886. position,
  1887. source_fd,
  1888. word.release_nonnull());
  1889. }
  1890. return make_ref_counted<AST::WriteRedirection>(
  1891. position,
  1892. source_fd,
  1893. word.release_nonnull());
  1894. }
  1895. default:
  1896. VERIFY_NOT_REACHED();
  1897. }
  1898. }
  1899. }