Home | History | Annotate | Download | only in include
      1 // Copyright 2011 the V8 project authors. All rights reserved.
      2 // Redistribution and use in source and binary forms, with or without
      3 // modification, are permitted provided that the following conditions are
      4 // met:
      5 //
      6 //     * Redistributions of source code must retain the above copyright
      7 //       notice, this list of conditions and the following disclaimer.
      8 //     * Redistributions in binary form must reproduce the above
      9 //       copyright notice, this list of conditions and the following
     10 //       disclaimer in the documentation and/or other materials provided
     11 //       with the distribution.
     12 //     * Neither the name of Google Inc. nor the names of its
     13 //       contributors may be used to endorse or promote products derived
     14 //       from this software without specific prior written permission.
     15 //
     16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     17 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     18 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     19 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     20 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     21 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     22 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     23 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     24 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     26 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27 
     28 #ifndef PREPARSER_H
     29 #define PREPARSER_H
     30 
     31 #include "v8.h"
     32 #include "v8stdint.h"
     33 
     34 namespace v8 {
     35 
     36 // The result of preparsing is either a stack overflow error, or an opaque
     37 // blob of data that can be passed back into the parser.
     38 class V8_EXPORT PreParserData {
     39  public:
     40   PreParserData(size_t size, const uint8_t* data)
     41       : data_(data), size_(size) { }
     42 
     43   // Create a PreParserData value where stack_overflow reports true.
     44   static PreParserData StackOverflow() { return PreParserData(0, NULL); }
     45 
     46   // Whether the pre-parser stopped due to a stack overflow.
     47   // If this is the case, size() and data() should not be used.
     48   bool stack_overflow() { return size_ == 0u; }
     49 
     50   // The size of the data in bytes.
     51   size_t size() const { return size_; }
     52 
     53   // Pointer to the data.
     54   const uint8_t* data() const { return data_; }
     55 
     56  private:
     57   const uint8_t* const data_;
     58   const size_t size_;
     59 };
     60 
     61 
     62 // Interface for a stream of Unicode characters.
     63 class V8_EXPORT UnicodeInputStream {  // NOLINT - V8_EXPORT is not a class name.
     64  public:
     65   virtual ~UnicodeInputStream();
     66 
     67   // Returns the next Unicode code-point in the input, or a negative value when
     68   // there is no more input in the stream.
     69   virtual int32_t Next() = 0;
     70 };
     71 
     72 
     73 // Preparse a JavaScript program. The source code is provided as a
     74 // UnicodeInputStream. The max_stack_size limits the amount of stack
     75 // space that the preparser is allowed to use. If the preparser uses
     76 // more stack space than the limit provided, the result's stack_overflow()
     77 // method will return true. Otherwise the result contains preparser
     78 // data that can be used by the V8 parser to speed up parsing.
     79 PreParserData V8_EXPORT Preparse(UnicodeInputStream* input,
     80                                 size_t max_stack_size);
     81 
     82 }  // namespace v8.
     83 
     84 #endif  // PREPARSER_H
     85