v8  3.11.10 (node 0.8.28)
V8 is Google's open source JavaScript engine
v8-preparser.h
Go to the documentation of this file.
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 "v8stdint.h"
32 
33 #ifdef _WIN32
34 
35 // Setup for Windows DLL export/import. When building the V8 DLL the
36 // BUILDING_V8_SHARED needs to be defined. When building a program which uses
37 // the V8 DLL USING_V8_SHARED needs to be defined. When either building the V8
38 // static library or building a program which uses the V8 static library neither
39 // BUILDING_V8_SHARED nor USING_V8_SHARED should be defined.
40 #if defined(BUILDING_V8_SHARED) && defined(USING_V8_SHARED)
41 #error both BUILDING_V8_SHARED and USING_V8_SHARED are set - please check the
42  build configuration to ensure that at most one of these is set
43 #endif
44 
45 #ifdef BUILDING_V8_SHARED
46 #define V8EXPORT __declspec(dllexport)
47 #elif USING_V8_SHARED
48 #define V8EXPORT __declspec(dllimport)
49 #else
50 #define V8EXPORT
51 #endif // BUILDING_V8_SHARED
52 
53 #else // _WIN32
54 
55 // Setup for Linux shared library export. There is no need to distinguish
56 // between building or using the V8 shared library, but we should not
57 // export symbols when we are building a static library.
58 #if defined(__GNUC__) && (__GNUC__ >= 4) && defined(V8_SHARED)
59 #define V8EXPORT __attribute__ ((visibility("default")))
60 #else // defined(__GNUC__) && (__GNUC__ >= 4)
61 #define V8EXPORT
62 #endif // defined(__GNUC__) && (__GNUC__ >= 4)
63 
64 #endif // _WIN32
65 
66 
67 namespace v8 {
68 
69 // The result of preparsing is either a stack overflow error, or an opaque
70 // blob of data that can be passed back into the parser.
72  public:
73  PreParserData(size_t size, const uint8_t* data)
74  : data_(data), size_(size) { }
75 
76  // Create a PreParserData value where stack_overflow reports true.
77  static PreParserData StackOverflow() { return PreParserData(0, NULL); }
78 
79  // Whether the pre-parser stopped due to a stack overflow.
80  // If this is the case, size() and data() should not be used.
81  bool stack_overflow() { return size_ == 0u; }
82 
83  // The size of the data in bytes.
84  size_t size() const { return size_; }
85 
86  // Pointer to the data.
87  const uint8_t* data() const { return data_; }
88 
89  private:
90  const uint8_t* const data_;
91  const size_t size_;
92 };
93 
94 
95 // Interface for a stream of Unicode characters.
96 class V8EXPORT UnicodeInputStream { // NOLINT - Thinks V8EXPORT is class name.
97  public:
98  virtual ~UnicodeInputStream();
99 
100  // Returns the next Unicode code-point in the input, or a negative value when
101  // there is no more input in the stream.
102  virtual int32_t Next() = 0;
103 };
104 
105 
106 // Preparse a JavaScript program. The source code is provided as a
107 // UnicodeInputStream. The max_stack_size limits the amount of stack
108 // space that the preparser is allowed to use. If the preparser uses
109 // more stack space than the limit provided, the result's stack_overflow()
110 // method will return true. Otherwise the result contains preparser
111 // data that can be used by the V8 parser to speed up parsing.
113  size_t max_stack_size);
114 
115 } // namespace v8.
116 
117 #endif // PREPARSER_H