/**
 * Contains the interface for reading tokens from a file.
 */
#ifndef TOKEN_H
#define TOKEN_H

#include "buffer.h"

/**
 * A list of all possible tokens.
 */
typedef enum {
	// Keywords
	TOKEN_MODULE,
	TOKEN_IMPORT,
	TOKEN_SEMICOLON,

	// Symbols
	TOKEN_PARENT_OPEN,
	TOKEN_PARENT_CLOSE,
	TOKEN_BRACKET_OPEN,
	TOKEN_BRACKET_CLOSE,
	TOKEN_COMMA,

	// Primitives
	TOKEN_VOID,

	// Variable
	TOKEN_IDENTIFIER,
} Token;

/**
 * Holds additional information about a token.
 */
typedef struct {
	/// @brief The textual representation of a token.
	char* text;

	/// @brief The length of the `text` string.
	size_t text_length;

	/// @brief The actual token.
	Token token;
} TokenInfo;

typedef struct TokenStream TokenStream;

/**
 * Returns a TokenStream for a given buffer.
 * 
 * When the tokenstream is closed, the underlying buffer is also closed.
 * 
 * @param buffer The buffer to read from.
 * @returns A handle to the TokenStream.
 */
TokenStream* tokenstream_open(Buffer* buffer);

/**
 * Closes a TokenStream.
 * @param ts The TokenStream to close.
 */
void tokenstream_close(TokenStream* ts);

/**
 * Gets the next token from the TokenStream.
 * @param ts The TokenStream to read from.
 * @returns The next token read.
 */
Token tokenstream_next(TokenStream* ts);

#endif