https://github.com/katyo/clex

Fast and robust C source lexer in Rust
https://github.com/katyo/clex

Last synced: 3 months ago
JSON representation

Fast and robust C source lexer in Rust

• Host: GitHub
• URL: https://github.com/katyo/clex
• Owner: katyo
• License: mit
• Created: 2022-07-03T07:06:40.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-07-03T18:55:36.000Z (almost 3 years ago)
• Last Synced: 2025-04-01T06:31:32.373Z (3 months ago)
• Language: Rust
• Size: 14.6 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# C source lexer in Rust

[![github](https://img.shields.io/badge/github-katyo/clex-8da0cb.svg?style=for-the-badge&logo=github)](https://github.com/katyo/clex)

[![crate](https://img.shields.io/crates/v/clex.svg?style=for-the-badge&color=fc8d62&logo=rust)](https://crates.io/crates/clex)

[![docs](https://img.shields.io/badge/docs.rs-clex-66c2a5?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K)](https://docs.rs/clex)

[![MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)

[![CI](https://img.shields.io/github/workflow/status/katyo/clex/Rust?style=for-the-badge&logo=github-actions&logoColor=white)](https://github.com/katyo/clex/actions?query=workflow%3ARust)

This is a fast and robust C source lexer in Rust. For example it can be used to extract some metadata from sources like comments or strings.

## Library usage

```rust

use clex::{Lexer, Token};

let src = r#"

static const char *s = "world";

int main() {

  // Hello world

  printf("Hello %s\n", s);

  return 0;

}

"#;

for lexeme in Lexer::from(src) {

  match lexeme.token {

    Token::Comment => {

      println!("comment: {:?}", lexeme.comment().unwrap());

    }

    Token::String => {

      println!("string: {:?}", lexeme.string().unwrap());

    }

    _ => {}

  }

}

```

This example prints the following:

```text

string: "world"

comment: "Hello world"

string: "Hello %s\n"

```

## Command-line usage

Currently command-line tool is used to test this library.

You can use it to analyze variuos C-sources and extract data.