blob: 61f0a6138f676bed1b8f87af2e97288e384e288c [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_TOKENIZER_H
2#define Py_TOKENIZER_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Martin v. Löwis00f1e3f2002-08-04 17:29:52 +00007#include "object.h"
Guido van Rossumf70e43a1991-02-19 12:39:46 +00008
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00009/* Tokenizer interface */
10
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000011#include "token.h" /* For token types */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000012
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000013#define MAXINDENT 100 /* Max indentation level */
Serhiy Storchaka94cf3082018-12-17 17:34:14 +020014#define MAXLEVEL 200 /* Max parentheses level */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000015
Neil Schemenauer3f993c32007-09-21 20:50:26 +000016enum decoding_state {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000017 STATE_INIT,
Pablo Galindo261a4522021-03-28 23:48:05 +010018 STATE_SEEK_CODING,
19 STATE_NORMAL
Neil Schemenauer3f993c32007-09-21 20:50:26 +000020};
21
Miss Islington (bot)1fb6b9e2021-05-22 15:23:26 -070022enum interactive_underflow_t {
23 /* Normal mode of operation: return a new token when asked in interactie mode */
24 IUNDERFLOW_NORMAL,
25 /* Forcefully return ENDMARKER when asked for a new token in interactive mode. This
Christian Claussdcfbe4f2021-10-07 16:31:33 +020026 * can be used to prevent the tokenizer to prompt the user for new tokens */
Miss Islington (bot)1fb6b9e2021-05-22 15:23:26 -070027 IUNDERFLOW_STOP,
28};
29
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000030/* Tokenizer state */
31struct tok_state {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000032 /* Input state; buf <= cur <= inp <= end */
33 /* NB an entire line is held in the buffer */
34 char *buf; /* Input buffer, or NULL; malloc'ed if fp != NULL */
35 char *cur; /* Next character in buffer */
36 char *inp; /* End of data in buffer */
Pablo Galindocd8dcbc2021-03-14 04:38:40 +010037 int fp_interactive; /* If the file descriptor is interactive */
38 char *interactive_src_start; /* The start of the source parsed so far in interactive mode */
39 char *interactive_src_end; /* The end of the source parsed so far in interactive mode */
Andy Lester384f3c52020-02-27 20:44:52 -060040 const char *end; /* End of input buffer if buf != NULL */
41 const char *start; /* Start of current token if not NULL */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000042 int done; /* E_OK normally, E_EOF at EOF, otherwise error code */
43 /* NB If done != E_OK, cur must be == inp!!! */
44 FILE *fp; /* Rest of input; NULL if tokenizing a string */
45 int tabsize; /* Tab spacing */
46 int indent; /* Current indentation index */
47 int indstack[MAXINDENT]; /* Stack of indents */
48 int atbol; /* Nonzero if at begin of new line */
49 int pendin; /* Pending indents (if > 0) or dedents (if < 0) */
Serhiy Storchakac6792272013-10-19 21:03:34 +030050 const char *prompt, *nextprompt; /* For interactive prompting */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000051 int lineno; /* Current line number */
Anthony Sottile995d9b92019-01-12 20:05:13 -080052 int first_lineno; /* First line of a single line or multi line string
53 expression (cf. issue 16806) */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000054 int level; /* () [] {} Parentheses nesting level */
55 /* Used to allow free continuations inside them */
Serhiy Storchaka94cf3082018-12-17 17:34:14 +020056 char parenstack[MAXLEVEL];
57 int parenlinenostack[MAXLEVEL];
Pablo Galindod6d63712021-01-19 23:59:33 +000058 int parencolstack[MAXLEVEL];
Victor Stinner7f2fee32011-04-05 00:39:01 +020059 PyObject *filename;
Serhiy Storchaka94cf3082018-12-17 17:34:14 +020060 /* Stuff for checking on different tab sizes */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000061 int altindstack[MAXINDENT]; /* Stack of alternate indents */
62 /* Stuff for PEP 0263 */
63 enum decoding_state decoding_state;
64 int decoding_erred; /* whether erred in decoding */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000065 char *encoding; /* Source encoding. */
66 int cont_line; /* whether we are in a continuation line. */
67 const char* line_start; /* pointer to start of current line */
Anthony Sottile995d9b92019-01-12 20:05:13 -080068 const char* multi_line_start; /* pointer to start of first line of
69 a single line or multi line string
70 expression (cf. issue 16806) */
Victor Stinner22a351a2010-10-14 12:04:34 +000071 PyObject *decoding_readline; /* open(...).readline */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000072 PyObject *decoding_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000073 const char* enc; /* Encoding for the current str. */
Pablo Galindo Salgado07cf66f2021-11-21 04:15:22 +000074 char* str; /* Source string being tokenized (if tokenizing from a string)*/
Andy Lester384f3c52020-02-27 20:44:52 -060075 char* input; /* Tokenizer's newline translated copy of the string. */
Guido van Rossumdcfcd142019-01-31 03:40:27 -080076
77 int type_comments; /* Whether to look for type comments */
Guido van Rossum495da292019-03-07 12:38:08 -080078
79 /* async/await related fields (still needed depending on feature_version) */
80 int async_hacks; /* =1 if async/await aren't always keywords */
81 int async_def; /* =1 if tokens are inside an 'async def' body. */
82 int async_def_indent; /* Indentation level of the outermost 'async def'. */
83 int async_def_nl; /* =1 if the outermost 'async def' had at least one
84 NEWLINE token after it. */
Miss Islington (bot)1fb6b9e2021-05-22 15:23:26 -070085 /* How to proceed when asked for a new token in interactive mode */
Serhiy Storchaka93242d72021-10-03 20:03:49 +030086 enum interactive_underflow_t interactive_underflow;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000087};
88
Benjamin Petersonaeaa5922009-11-13 00:17:59 +000089extern struct tok_state *PyTokenizer_FromString(const char *, int);
90extern struct tok_state *PyTokenizer_FromUTF8(const char *, int);
Serhiy Storchakac6792272013-10-19 21:03:34 +030091extern struct tok_state *PyTokenizer_FromFile(FILE *, const char*,
92 const char *, const char *);
Tim Petersdbd9ba62000-07-09 03:09:57 +000093extern void PyTokenizer_Free(struct tok_state *);
Andy Lester384f3c52020-02-27 20:44:52 -060094extern int PyTokenizer_Get(struct tok_state *, const char **, const char **);
Guido van Rossuma3309961993-07-28 09:05:47 +000095
Pablo Galindof2cf1e32019-04-13 17:05:14 +010096#define tok_dump _Py_tok_dump
97
Guido van Rossuma3309961993-07-28 09:05:47 +000098#ifdef __cplusplus
99}
100#endif
101#endif /* !Py_TOKENIZER_H */