Giter Site home page Giter Site logo

vtparse's Introduction

VTParse - an implementation of Paul Williams' DEC compatible state machine parser
          <http://www.vt100.net/emu/dec_ansi_parser>

Author: Joshua Haberman <[email protected]>

This code is in the public domain.

BUILDING
========

Ruby is required at build time to generate the tables in C.  To build the library
and test program, just type make:

$ make
<this will create the test program and libvtparse.a>

I have only tested the build on Mac OS X and Linux, but it should build anywhere
Ruby and GCC are available.  Other C compilers should work as well, I just haven't
tried them.

TEST PROGRAM
============

The test program shows how to use vtparse.  To see what kind of data is returned
by the library, try:

--------------------------------

$ vim > terminaloutput
<type ':q<ENTER>' to exit vim, even though you won't see it>
$ ./test < terminaloutput  | head -16
Received action ESC_DISPATCH
Char: 0x37 ('7')

Received action CSI_DISPATCH
Char: 0x68 ('h')
1 Intermediate chars:
  0x3f ('?')
1 Parameters:
        47

Received action CSI_DISPATCH
Char: 0x68 ('h')
1 Intermediate chars:
  0x3f ('?')
1 Parameters:
        1

---------------------------------

VERIFYING
=========

You can also verify the validity of the state tables by running:

$ ruby vtparse_check_tables.rb
Tables had all necessary transitions defined.

This checks to make sure that state transitions are defined for all states, for all
characters 0-0xA0.


TODO
====

One possible enhancement is to allow the client to pass a return value from the
callback to say "stop parsing."  The vtparse() function could return the number
of bytes consumed from the input buffer.  This would be quite simple to do if
someone needed this functionality, but I don't, so I didn't bother.

Currently there is no explicit character set support.  I don't know enough about
the relevant standards to know if vtparse should have character set support, or
what that support would look like.  Suggestions along this vein are very welcome!

CREDITS
=======

Thanks to Julian Scheid for several bugfixes and enhancements.

vtparse's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

vtparse's Issues

Out-of-bounds write when parsing CSI parameters

Feeding the following character sequence into ./test causes an out-of-bounds write in line 60 of vtparse.c:

echo -en "\e["`printf '99;%.0s' {0..15}`m | ./test

Relevant code snippet:

            /* process the param character */
            if(ch == ';')
            {
                parser->num_params += 1;
                parser->params[parser->num_params-1] = 0; /* <- bad */
            }

Fortunately, at the moment, this is not a severe issue, since the next member after params in struct vtparser is num_params, which is reset to zero in the above code. However, if params was at the end of the vtparser structure, this would allow to override whatever comes next in memory. Still, even with the way it is right now, writing outside the bounds of a fixed-size array is undefined behaviour and should be fixed.

I suggest an explicit check before incrementing num_params and going to an error state if parser->num_params is greater than the size of the params array.

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.