funki_lang 0.1.3

A customisable embeddable functional langauge.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
extern crate core;
#[macro_use]
extern crate lalrpop_util;

use std::cmp;
use std::collections::HashMap;
use std::fmt::{Debug, Formatter};

use itertools::Itertools;
use lalrpop_util::ParseError;

use crate::ast::{ParserState, Program};
use crate::data_types::{InterpretError, InterpretVal};
use crate::external_operators::{
  CustomBinOp, CustomBuiltIn, CustomType, CustomUnaryOp, OperatorChars,
};
use crate::interpreter::{interpret, Customs};
use crate::parser::language_definition::ProgramParser;

mod ast;
mod data_types;
mod interpreter;
mod parser;
mod test;

pub mod external_operators;

/// Represents a language to be parsed
pub struct Language<C: CustomType> {
  unary_operators: HashMap<OperatorChars, CustomUnaryOp<C>>,
  binary_operators: HashMap<OperatorChars, CustomBinOp<C>>,
  built_ins: HashMap<String, CustomBuiltIn<C>>,
}

/// Represents a set of template functions
#[derive(Debug)]
pub struct Script<C: CustomType> {
  lang: String,
  temp: Program,
  unary_operators: HashMap<OperatorChars, CustomUnaryOp<C>>,
  binary_operators: HashMap<OperatorChars, CustomBinOp<C>>,
  built_ins: HashMap<String, CustomBuiltIn<C>>,
}

/// Represents an argument being parsed in to a function call
pub enum Argument<C: CustomType> {
  /// Basic integer type
  Int(i32),
  /// Basic String type
  String(String),
  /// Tuple type
  Tuple(Vec<Argument<C>>),
  /// List type
  List(Vec<Argument<C>>),
  /// Custom data types.
  /// If multiple data types are required use aan enum type for the custom type.
  Custom(C),
}

impl<C: CustomType> Clone for Argument<C> {
  fn clone(&self) -> Self {
    match &self {
      Argument::Int(i) => Argument::Int(*i),
      Argument::String(s) => Argument::String(s.clone()),
      Argument::Tuple(t) => Argument::Tuple(t.clone()),
      Argument::List(t) => Argument::List(t.clone()),
      Argument::Custom(c) => Argument::Custom(c.clone()),
    }
  }
}

/// Represents a function from a template
/// Can contain an argument also
pub struct LangFunc<'a, C: CustomType> {
  lang: &'a Script<C>,
  name: String,
  arg: Option<Argument<C>>,
  text: String,
}

impl<C: CustomType> Default for Language<C> {
  fn default() -> Self {
    Self::new()
  }
}

impl<C: CustomType> Language<C> {
  pub fn new() -> Self {
    Self {
      unary_operators: Default::default(),
      binary_operators: Default::default(),
      built_ins: Default::default(),
    }
  }

  /// Adds a custom binary operator to the Language
  pub fn add_bin_op(&mut self, char: OperatorChars, op: CustomBinOp<C>) -> &Self {
    self.binary_operators.entry(char).or_insert(op);
    self
  }

  /// Adds a custom unary operator to the Language
  pub fn add_unary_op(&mut self, char: OperatorChars, op: CustomUnaryOp<C>) -> &Self {
    self.unary_operators.entry(char).or_insert(op);
    self
  }

  /// Adds a custom builtin function to the Language
  pub fn add_custom_function(&mut self, name: String, func: CustomBuiltIn<C>) -> &Self {
    self.built_ins.entry(name).or_insert(func);
    self
  }

  /// Parses a set of code into a template
  pub fn parse(&self, code: String) -> Result<Script<C>, LanguageErr> {
    let parser = ProgramParser::new();
    let parser_state = ParserState {
      unary_ops: self.unary_operators.keys().cloned().collect(),
      binary_ops: self.binary_operators.keys().cloned().collect(),
    };
    let res: Result<Program, ParseError<usize, _, (usize, String, usize)>> =
      parser.parse(&parser_state, &code);

    match res {
      Ok(l) => Ok(Script {
        temp: l,
        lang: code,
        unary_operators: self.unary_operators.clone(),
        binary_operators: self.binary_operators.clone(),
        built_ins: self.built_ins.clone(),
      }),
      Err(e) => Err(LanguageErr::new_from_parser_err(
        e.map_token(|_| "".to_string()),
        code,
      )),
    }
  }
}

impl Script<BlankCustom> {
  /// Builds a language from a code string
  ///
  /// ## Example
  /// ```
  /// use funki_lang::{Script, BlankCustom};
  /// let x = Script::<BlankCustom>::from_text("#main x -> x + 1;");
  /// ```
  pub fn from_text(lang: &str) -> Result<Self, LanguageErr> {
    let parser: ProgramParser = ProgramParser::new();
    let res = parser.parse(&ParserState::new(), lang);
    match res {
      Ok(l) => Ok(Self {
        temp: l,
        lang: lang.to_string(),
        unary_operators: Default::default(),
        binary_operators: Default::default(),
        built_ins: Default::default(),
      }),
      Err(e) => {
        // println!("{}", e);
        Err(LanguageErr::new_from_parser_err(
          e.map_token(|_| "".to_string()),
          lang.to_string(),
        ))
      }
    }
  }
}

impl<C: CustomType> Script<C> {
  /// Lists the available functions
  ///
  /// ## Example
  /// ```
  /// use funki_lang::{Script, BlankCustom};
  /// let x = Script::<BlankCustom>::from_text("#main x -> x + 1;").unwrap();
  /// x.list(); // -> ["main"]
  /// ```
  pub fn list(&self) -> Vec<String> {
    return self.temp.env.keys().map(|s| s.to_string()).collect();
  }

  /// Selects a function from the ParsedTemplatete
  ///
  /// ## ExamParsedTemplate/// ```
  /// use funki_templates::{Script, BlankCustom};
  /// let x = Script::<BlankCustom>::from_text("#main x -> x + 1;").unwrap();
  /// let f = x.function("main");
  /// ```
  pub fn function(&self, name: &str) -> Result<LangFunc<C>, LanguageErr> {
    if self.temp.env.contains_key(name) {
      Ok(LangFunc {
        lang: self,
        name: name.to_string(),
        arg: None,
        text: self.lang.clone(),
      })
    } else {
      Err(LanguageErr::new_no_loc(format!(
        "Cannot find function \"{}\".",
        name
      )))
    }
  }
}

/// Type for the values returned from the interpretation
pub enum ReturnVal<T: CustomType> {
  String(String),
  Int(i32),
  Bool(bool),
  Tuple(Vec<ReturnVal<T>>),
  List(Vec<ReturnVal<T>>),
  Custom(T),
}

impl<'a, C: CustomType> LangFunc<'a, C> {
  /// Adds an argument for aParsedTemplateion call
  ///
  /// #ParsedTemplateple
  /// ```
  /// use funki_lang::{Argument, Script, BlankCustom};
  /// let x = Script::<BlankCustom>::from_text("#main x -> x + 4;").unwrap();
  /// let f = x.function("main").unwrap();
  /// let f = f.arg(Argument::Int(5));
  /// f.call().unwrap(); // -> ReturnVal::Int(9)
  /// ```
  pub fn arg(mut self, arg: Argument<C>) -> Self {
    self.arg = Some(arg);
    self
  }
  /// Interprets this function
  /// Can return a language errParsedTemplatethe interpretation faiParsedTemplate//
  /// ## Example
  /// ```
  /// use funki_lang::{Language, Script, BlankCustom};
  /// let x = Script::<BlankCustom>::from_text("#main 5;").unwrap();
  /// let f = x.function("main").unwrap();
  /// f.call().unwrap(); // -> ReturnVal::Int(5)
  /// ```
  pub fn call(&self) -> Result<ReturnVal<C>, LanguageErr> {
    if let Some(x) = &self.arg {
      interpret(
        &self.lang.temp,
        self.name.as_str(),
        InterpretVal::from_arg(x),
        &Customs::new_from_hash(
          self.lang.binary_operators.clone(),
          self.lang.unary_operators.clone(),
          self.lang.built_ins.clone(),
        ),
      )
    } else {
      interpret(
        &self.lang.temp,
        self.name.as_str(),
        InterpretVal::Tuple(vec![]),
        &Customs::new_from_hash(Default::default(), Default::default(), Default::default()),
      )
    }
    .map_err(|e| LanguageErr::new_from_int_err(e, self.text.clone()))
  }
}

/// A language error with a location
pub struct LocationLangErr {
  message: String,
  lines: (usize, usize),
  char: (usize, usize),
  section: String,
}

/// An enum for the possible types of error that can result from interpretation
pub enum LanguageErr {
  NoLoc(String),
  Loc(LocationLangErr),
}

impl LanguageErr {
  /// Creates a language error with location information
  /// Adds in the original language string so the line numbers and string section can be found
  fn new_loc(message: String, location: (usize, usize), lang: String) -> Self {
    let (start_line, start_char) = get_lang_pos(&lang, location.0);
    let (end_line, end_char) = get_lang_pos(&lang, location.1);
    LanguageErr::Loc(LocationLangErr {
      lines: (start_line, end_line),
      section: lang[location.0..location.1].to_string(),
      char: (start_char, end_char),
      message,
    })
  }

  /// Creates a location error with no location data
  fn new_no_loc(message: String) -> Self {
    LanguageErr::NoLoc(message)
  }

  /// Creates a location error from an interpretation error
  fn new_from_int_err(err: InterpretError, lang: String) -> Self {
    if err.location.is_some() {
      Self::new_loc(err.message, err.location.unwrap(), lang)
    } else {
      Self::new_no_loc(err.message)
    }
  }

  /// Creates a location error from a parser error
  fn new_from_parser_err(
    err: ParseError<usize, String, (usize, String, usize)>,
    lang: String,
  ) -> Self {
    match err {
      ParseError::InvalidToken { location } => {
        let (line, char) = get_lang_pos(&lang, location);
        Self::Loc(LocationLangErr {
          message: "Invalid token".to_string(),
          lines: (line, line),
          char: (char, char),
          section: lang[location..location + 10].to_string(),
        })
      }
      ParseError::UnrecognizedEOF { location, .. } => {
        let (line, char) = get_lang_pos(&lang, location);
        Self::Loc(LocationLangErr {
          message: "Unexpected End of File".to_string(),
          lines: (line, line),
          char: (char, char),
          section: lang[cmp::min(location - 10, 0)..].to_string(),
        })
      }
      ParseError::UnrecognizedToken {
        token: (l, _, r), ..
      } => {
        let (start_line, start_char) = get_lang_pos(&lang, l);
        let (end_line, end_char) = get_lang_pos(&lang, r);
        Self::Loc(LocationLangErr {
          message: "Unrecognised token".to_string(),
          lines: (start_line, end_line),
          char: (start_char, end_char),
          section: lang[l..r].to_string(),
        })
      }
      ParseError::ExtraToken {
        token: (l, _, r), ..
      } => {
        let (start_line, start_char) = get_lang_pos(&lang, l);
        let (end_line, end_char) = get_lang_pos(&lang, r);
        Self::Loc(LocationLangErr {
          message: "Extra token".to_string(),
          lines: (start_line, end_line),
          char: (start_char, end_char),
          section: lang[l..r].to_string(),
        })
      }
      ParseError::User { error: (l, m, r) } => {
        let (start_line, start_char) = get_lang_pos(&lang, l);
        let (end_line, end_char) = get_lang_pos(&lang, r);
        Self::Loc(LocationLangErr {
          message: m,
          lines: (start_line, end_line),
          char: (start_char, end_char),
          section: lang[l..r].to_string(),
        })
      }
    }
  }
}

fn get_lang_pos(lang: &str, pos: usize) -> (usize, usize) {
  let new_lines = lang[0..pos]
    .as_bytes()
    .iter()
    .enumerate()
    .filter(|(_, c)| **c == b'\n');
  let line_num = new_lines.clone().count();
  let char = pos - new_lines.last().unwrap_or((0, &b'x')).0;

  (line_num, char)
}

impl Debug for LanguageErr {
  fn fmt(&self, fmt: &mut Formatter<'_>) -> std::fmt::Result {
    match self {
      LanguageErr::Loc(l) => {
        write!(
          fmt,
          "Error: \"{}\"\nAt lines: {}:{} - {}:{}\nCode: `{}`",
          l.message,
          l.lines.0 + 1,
          l.char.0,
          l.lines.1 + 1,
          l.char.1,
          l.section
        )
      }
      LanguageErr::NoLoc(l) => {
        write!(fmt, "Error: {}", l)
      }
    }
  }
}

impl<C: CustomType> Debug for ReturnVal<C> {
  fn fmt(&self, fmt: &mut Formatter<'_>) -> std::fmt::Result {
    match self {
      ReturnVal::Bool(b) => write!(fmt, "Bool({})", b),
      ReturnVal::Int(i) => write!(fmt, "Int({})", i),
      ReturnVal::String(s) => write!(fmt, "String({})", s),
      ReturnVal::Tuple(v) => write!(
        fmt,
        "Tuple({})",
        v.iter().map(|i| format!("{:?}", i)).join(", ")
      ),
      ReturnVal::List(v) => write!(
        fmt,
        "List({})",
        v.iter().map(|i| format!("{:?}", i)).join(", ")
      ),
      ReturnVal::Custom(v) => write!(fmt, "Custom({:?})", v),
    }
  }
}

impl<C: CustomType> ToString for ReturnVal<C> {
  fn to_string(&self) -> String {
    match self {
      ReturnVal::Bool(b) => b.to_string(),
      ReturnVal::Int(i) => i.to_string(),
      ReturnVal::String(s) => s.to_string(),
      ReturnVal::Tuple(v) => format!("({})", v.iter().map(|i| i.to_string()).join(", ")),
      ReturnVal::List(v) => format!("[{}]", v.iter().map(|i| i.to_string()).join(", ")),
      ReturnVal::Custom(v) => v.to_string(),
    }
  }
}

/// A blank custom type to use if no custom types are required
#[derive(Clone, Debug, PartialEq)]
pub struct BlankCustom {}

impl ToString for BlankCustom {
  fn to_string(&self) -> String {
    "Blank".to_string()
  }
}

impl CustomType for BlankCustom {}