Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cairo language #4162

Closed
wants to merge 1 commit into from
Closed

Add cairo language #4162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
252 changes: 252 additions & 0 deletions src/languages/cairo.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,252 @@
/*
Language: Cairo
Author: Matesz Kowalski <[email protected]>
Website: https://www.cairo-lang.org/
Category: common, system, blockchain
*/

/** @type LanguageFn */
export default function (hljs) {
const regex = hljs.regex;

const NUMBER_SUFFIX = "([u](8|16|32|64|128|256|size)|[i](8|16|32|64|128))?";
const KEYWORDS = [
"as",
"break",
"const",
"continue",
"else",
"enum",
"extern",
"false",
"fn",
"if",
"impl",
"implicits",
"let",
"loop",
"match",
"mod",
"mut",
"nopanic",
"of",
"pub",
"ref",
"return",
"self",
"struct",
"super",
"trait",
"true",
"type",
"use",
"while",
];
const LITERALS = ["true", "false"];
const BUILTINS = [
"Copy",
"Send",
"Serde",
"Sized",
"Sync",
"Drop",
"Fn",
"FnMut",
"FnOnce",
"ToOwned",
"Clone",
"Debug",
"PartialEq",
"PartialOrd",
"Eq",
"Ord",
"AsRef",
"AsMut",
"Into",
"From",
"Default",
"Iterator",
"Extend",
"IntoIterator",
"DoubleEndedIterator",
"ExactSizeIterator",
"SliceConcatExt",
"ToString",
"assert!",
"assert_eq!",
"assert_ne!",
"assert_lt!",
"assert_le!",
"assert_gt!",
"assert_ge!",
"format!",
"write!",
"writeln!",
"get_dep_component!",
"get_dep_component_mut!",
"component!",
"consteval_int!",
"array!",
"panic!",
"print!",
"println!",
];
const TYPES = [
"felt252",
"i8",
"i16",
"i32",
"i64",
"i128",
"u8",
"u16",
"u32",
"u64",
"u128",
"u256",
"usize",
"bool",
"Box",
"Option",
"Result",
"ByteArray",
];
return {
name: "Cairo",
aliases: ["cairo"],
keywords: {
$pattern: hljs.IDENT_RE + "!?",
type: TYPES,
keyword: KEYWORDS,
literal: LITERALS,
built_in: BUILTINS,
},
illegal: "</",
contains: [
hljs.C_LINE_COMMENT_MODE,
hljs.inherit(hljs.QUOTE_STRING_MODE, {
begin: /b?"/,
illegal: null,
}),
{
className: "string",
variants: [
{ begin: /b?r(#*)"(.|\n)*?"\1(?!#)/ },
{ begin: /b?'\\?(x\w{2}|u\w{4}|U\w{8}|.)'/ },
],
},
{
className: "symbol",
begin: /'[a-zA-Z_][a-zA-Z0-9_]*/,
},
{
className: "number",
variants: [
{ begin: "\\b0b([01_]+)" + NUMBER_SUFFIX },
{ begin: "\\b0o([0-7_]+)" + NUMBER_SUFFIX },
{ begin: "\\b0x([A-Fa-f0-9_]+)" + NUMBER_SUFFIX },
{
begin:
"\\b(\\d[\\d_]*(\\.[0-9_]+)?([eE][+-]?[0-9_]+)?)" + NUMBER_SUFFIX,
},
],
relevance: 0,
},
{
begin: [/fn/, /\s+/, hljs.UNDERSCORE_IDENT_RE],
className: {
1: "keyword",
3: "title.function",
},
},
{
className: "meta",
begin: "#!?\\[",
end: "\\]",
contains: [
{
className: "string",
begin: /"/,
end: /"/,
contains: [hljs.BACKSLASH_ESCAPE],
},
],
},
{
begin: [/let/, /\s+/, /(?:mut\s+)?/, hljs.UNDERSCORE_IDENT_RE],
className: {
1: "keyword",
3: "keyword",
4: "variable",
},
},
// must come before impl/for rule later
{
begin: [/for/, /\s+/, hljs.UNDERSCORE_IDENT_RE, /\s+/, /in/],
className: {
1: "keyword",
3: "variable",
5: "keyword",
},
},
// Support for cairo's "impl ImplementationName of TraitName {}"
{
begin: [
/impl/,
/\s+/,
hljs.UNDERSCORE_IDENT_RE,
/\s+/,
/of/,
/\s+/,
hljs.UNDERSCORE_IDENT_RE,
],
className: {
1: "keyword", // classifies "impl"
3: "title.class", // classifies the `implementation` name.
5: "keyword", // classifies "of"
7: "title.class", // classifies Trait
},
},
{
begin: [/type/, /\s+/, hljs.UNDERSCORE_IDENT_RE],
className: {
1: "keyword",
3: "title.class",
},
},
{
begin: [
/(?:trait|enum|struct|union|impl|for)/,
/\s+/,
hljs.UNDERSCORE_IDENT_RE,
],
className: {
1: "keyword",
3: "title.class",
},
},
{
begin: hljs.IDENT_RE + "::",
keywords: {
keyword: "Self",
built_in: BUILTINS,
type: TYPES,
},
},
{
className: "punctuation",
begin: "->",
},
{
className: "title.function.invoke",
relevance: 0,
begin: regex.concat(
/\b/,
/(?!let|for|while|if|else|match\b)/,
hljs.IDENT_RE,
regex.lookahead(/\s*\(/)
),
},
],
};
}
79 changes: 79 additions & 0 deletions test/markup/cairo/default.expect.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<span class="hljs-keyword">fn</span> <span class="hljs-title function_">main</span>() {
<span class="hljs-keyword">let</span> <span class="hljs-variable">a</span>: <span class="hljs-type">felt252</span> = <span class="hljs-string">&#x27;a&#x27;</span>;
<span class="hljs-built_in">println!</span>(<span class="hljs-string">&quot;test&quot;</span>);
}

<span class="hljs-keyword">impl</span> <span class="hljs-title class_">UpgradeableImpl</span> <span class="hljs-keyword">of</span> <span class="hljs-title class_">IUpgradeable</span>&lt;ContractState&gt; {}

<span class="hljs-keyword">fn</span> <span class="hljs-title function_">test</span>() {
<span class="hljs-built_in">print!</span>(<span class="hljs-string">&quot;test2&quot;</span>);
}

<span class="hljs-keyword">struct</span> <span class="hljs-title class_">Abc</span> {
a: <span class="hljs-type">u256</span>,
<span class="hljs-keyword">pub</span> b: <span class="hljs-type">usize</span>
}

<span class="hljs-keyword">enum</span> <span class="hljs-title class_">EnumAbc</span> {
A,
B
}
<span class="hljs-keyword">fn</span> <span class="hljs-title function_">main</span>() <span class="hljs-punctuation">-&gt;</span> <span class="hljs-type">u32</span> {
<span class="hljs-title function_ invoke__">fib</span>(<span class="hljs-number">16</span>)
}

<span class="hljs-keyword">use</span> core::traits::<span class="hljs-built_in">Into</span> <span class="hljs-keyword">as</span> into_trait;
<span class="hljs-keyword">use</span> core::traits::TryInto;

<span class="hljs-keyword">const</span> FOO: <span class="hljs-type">u32</span> = <span class="hljs-number">42</span>;

<span class="hljs-keyword">fn</span> <span class="hljs-title function_">fib</span>(<span class="hljs-keyword">mut</span> n: <span class="hljs-type">u32</span>) <span class="hljs-punctuation">-&gt;</span> <span class="hljs-type">u32</span> {
<span class="hljs-keyword">let</span> <span class="hljs-keyword">mut </span><span class="hljs-variable">a</span>: <span class="hljs-type">u32</span> = <span class="hljs-number">0</span>;
<span class="hljs-keyword">let</span> <span class="hljs-keyword">mut </span><span class="hljs-variable">b</span>: <span class="hljs-type">u32</span> = <span class="hljs-number">1</span>;
<span class="hljs-keyword">while</span> n != <span class="hljs-number">0</span> {
n = n - <span class="hljs-number">1</span>;
<span class="hljs-keyword">let</span> <span class="hljs-variable">temp</span> = b;
b = a + b;
a = temp;
};
a
}

<span class="hljs-keyword">type</span> <span class="hljs-title class_">Pair</span> = (<span class="hljs-type">u32</span>, <span class="hljs-type">u32</span>);

<span class="hljs-keyword">enum</span> <span class="hljs-title class_">Color</span> {
Red: (),
Green: (),
Blue: (),
}

<span class="hljs-keyword">trait</span> <span class="hljs-title class_">Shape</span>&lt;T&gt; {
<span class="hljs-keyword">const</span> SHAPE_CONST: <span class="hljs-type">felt252</span>;

<span class="hljs-keyword">type</span> <span class="hljs-title class_">ShapePair</span>;

<span class="hljs-keyword">fn</span> <span class="hljs-title function_">area</span>(<span class="hljs-keyword">self</span>: T) <span class="hljs-punctuation">-&gt;</span> <span class="hljs-type">u32</span>;
}

[<span class="hljs-title function_ invoke__">derive</span>(<span class="hljs-built_in">Drop</span>, <span class="hljs-built_in">Serde</span>, <span class="hljs-built_in">PartialEq</span>)]
<span class="hljs-keyword">struct</span> <span class="hljs-title class_">Circle</span> {
radius: <span class="hljs-type">u32</span>,
}

<span class="hljs-keyword">impl</span> <span class="hljs-title class_">CircleShape</span> <span class="hljs-keyword">of</span> <span class="hljs-title class_">Shape</span>&lt;Circle&gt; {
<span class="hljs-keyword">type</span> <span class="hljs-title class_">ShapePair</span> = (Circle, Circle);

<span class="hljs-keyword">const</span> SHAPE_CONST: <span class="hljs-type">felt252</span> = <span class="hljs-string">&#x27;xyz&#x27;</span>;

<span class="hljs-keyword">fn</span> <span class="hljs-title function_">area</span>(<span class="hljs-keyword">self</span>: Circle) <span class="hljs-punctuation">-&gt;</span> <span class="hljs-type">u32</span> {
<span class="hljs-number">3</span> * <span class="hljs-keyword">self</span>.radius * <span class="hljs-keyword">self</span>.radius
}
}

<span class="hljs-keyword">mod</span> tests {
<span class="hljs-keyword">use</span> super::fib <span class="hljs-keyword">as</span> fib_function;

<span class="hljs-keyword">fn</span> <span class="hljs-title function_">it_works</span>() {
<span class="hljs-title function_ invoke__">assert</span>(<span class="hljs-title function_ invoke__">fib_function</span>(<span class="hljs-number">16</span>) == <span class="hljs-number">987</span>, <span class="hljs-symbol">&#x27;it</span> works!&#x27;);
}
}
Loading