Light

s-tikhomirov / solidity-latex-highlighting Goto Github PK

View Code? Open in Web Editor NEW

108.0 4.0 43.0 166 KB

Include nice-looking Solidity examples into LaTeX files

License: MIT License

TeX 100.00%

solidity ethereum latex listings tex highlighting

solidity-latex-highlighting's Introduction

Solidity LaTeX Highlighting

Solidity is a major programming language for Ethereum smart contracts. Solidity LaTeX highlighting helps researchers include readable code examples in their papers. Compared to some other previous attempts, this highlighter fully supports the Solidity syntax (if you think this is not the case, feel free to submit an issue or a pull request).

Usage

Source

\documentclass{article}

\input{solidity-highlighting.tex}	% copy the file from this repo

\begin{lstlisting}[language=Solidity]
pragma solidity 0.4.16;

contract TestContract {
    
	string private myString = "foo";
	
	function getString() constant returns (string) {
	    return myString;
	}
	
	function setString (string _string) {
	    myString = _string;
	}
}
\end{lstlisting}

Result

solidity-latex-highlighting's People

Contributors

Stargazers

Watchers

solidity-latex-highlighting's Issues

Distinguish `var balance` and `this.balance`

In both cases, balance is highlighted as a keyword. In reality, the former is just a variable, whereas the latter is a property of an address.

Same problem with all special properties, e.g., msg.foo, block.timestamp, etc.

Add more examples

Include some complex contracts.

add 'emit' as keyword?

Make line numbering optional

E.g., it doesn't make sense for very short code examples.

Add highlighting of hex addresses

E.g., 0x419c92586FBFE7DC326288DfEA7f465f292610d4 is not highlighted.

Would be nice to:

Detect and highlight tokens starting with 0x;
Highlight only those of the appropriate length.

Highlight operators

It would be nice to highlight operators (+, &&, <=, etc), like Remix does.

Listings package supports only 3 keyword levels (check if it is true), is there a workaround?

new keywords

I noticed that the keywords virtual, abstract, and override are not highlighted.
Could these be added?

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.