From 40a3135f24b66574518c1b206d012b10332782c7 Mon Sep 17 00:00:00 2001 From: "Christopher L. Conway" Date: Sat, 1 May 2010 20:43:30 +0000 Subject: [PATCH] Adding comments to bounded token files --- src/parser/bounded_token_buffer.cpp | 17 +++++++++ src/parser/bounded_token_buffer.h | 53 ++++++++++------------------ src/parser/bounded_token_factory.cpp | 2 +- src/parser/bounded_token_factory.h | 5 ++- 4 files changed, 41 insertions(+), 36 deletions(-) diff --git a/src/parser/bounded_token_buffer.cpp b/src/parser/bounded_token_buffer.cpp index 1c593367e..8bd896cd4 100644 --- a/src/parser/bounded_token_buffer.cpp +++ b/src/parser/bounded_token_buffer.cpp @@ -1,3 +1,20 @@ +/********************* */ +/** bounded_token_buffer.h + ** Original author: cconway + ** Major contributors: mdeters + ** Minor contributors (to current version): none + ** This file is part of the CVC4 prototype. + ** Copyright (c) 2009, 2010 The Analysis of Computer Systems Group (ACSys) + ** Courant Institute of Mathematical Sciences + ** New York University + ** See the file COPYING in the top-level source directory for licensing + ** information. + ** + ** An ANTLR3 bounded token stream implementation. + ** This code is largely based on the original token buffer implementation + ** in libantlr3c, by Jim Idle. + **/ + /// \file /// Default implementation of CommonTokenStream /// diff --git a/src/parser/bounded_token_buffer.h b/src/parser/bounded_token_buffer.h index 9c18ec3de..663e5b403 100644 --- a/src/parser/bounded_token_buffer.h +++ b/src/parser/bounded_token_buffer.h @@ -1,40 +1,25 @@ -/** \file - * Defines the interface for an ANTLR3 common token stream. Custom token streams should create - * one of these and then override any functions by installing their own pointers - * to implement the various functions. - */ +/********************* */ +/** bounded_token_buffer.h + ** Original author: cconway + ** Major contributors: mdeters + ** Minor contributors (to current version): none + ** This file is part of the CVC4 prototype. + ** Copyright (c) 2009, 2010 The Analysis of Computer Systems Group (ACSys) + ** Courant Institute of Mathematical Sciences + ** New York University + ** See the file COPYING in the top-level source directory for licensing + ** information. + ** + ** An ANTLR3 bounded token stream. The stream has a bounded + ** lookahead/behind k. Calling LT(i) with i > k or i < -k will raise + ** an exception. Only use this factory if you *know* that the grammar + ** has bounded lookahead (e.g., if you've set the k parameter in the + ** parser. + **/ + #ifndef __CVC4__PARSER__BOUNDED_TOKEN_BUFFER_H #define __CVC4__PARSER__BOUNDED_TOKEN_BUFFER_H -// [The "BSD licence"] -// Copyright (c) 2005-2009 Jim Idle, Temporal Wave LLC -// http://www.temporal-wave.com -// http://www.linkedin.com/in/jimidle -// -// All rights reserved. -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions -// are met: -// 1. Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// 2. Redistributions in binary form must reproduce the above copyright -// notice, this list of conditions and the following disclaimer in the -// documentation and/or other materials provided with the distribution. -// 3. The name of the author may not be used to endorse or promote products -// derived from this software without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR -// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES -// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. -// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, -// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT -// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF -// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - #include namespace CVC4 { diff --git a/src/parser/bounded_token_factory.cpp b/src/parser/bounded_token_factory.cpp index d47f67cbd..c9f9b66e7 100644 --- a/src/parser/bounded_token_factory.cpp +++ b/src/parser/bounded_token_factory.cpp @@ -10,7 +10,7 @@ ** See the file COPYING in the top-level source directory for licensing ** information. ** - ** [[ Add file-specific comments here ]] + ** An ANTLR3 bounded token factory implementation. **/ #include diff --git a/src/parser/bounded_token_factory.h b/src/parser/bounded_token_factory.h index 761ac762f..faf289ef4 100644 --- a/src/parser/bounded_token_factory.h +++ b/src/parser/bounded_token_factory.h @@ -10,7 +10,10 @@ ** See the file COPYING in the top-level source directory for licensing ** information. ** - ** [[ Add file-specific comments here ]] + ** An ANTLR3 bounded token factory. The factory has a fixed number of + ** tokens that are re-used as parsing proceeds. Only use this factory + ** if you *know* that the number of active tokens will be bounded + ** (e.g., if you're using a bounded token stream). **/ #include "cvc4parser_private.h" -- 2.30.2