Lexi.h

// Copyright (c) Chemical Language Foundation 2025.

//
// Created by Waqas Tahir on 26/01/2024.
//

#pragma once

#include <string>
#include <fstream>
#include "Parser.h"
#include "utils/Benchmark.h"
#include "stream/FileInputSource.h"

/**
 * same as benchLexFile with istream
 * benchmark lexing the filename (relative to in the current project)
 * @return the tokens
 */
void benchLexFile(Parser* lexer, const char* path, BenchmarkResults& results);

/**
 * same as benchLexFile with istream
 * benchmark lexing the filename (relative to in the current project)
 * @return the tokens
 */
void benchLexFile(Parser* lexer, const char* path);

/**
 * same as lexFile with istream
 * lex the file at path (relative to in the current project)
 * @param fileName
 * @return the tokens
 */
void lexFile(Parser* lexer, const char* path);

/**
 * benchmark lexing the given input stream
 * It will print helpful messages like lexing started and time taken by lexing in milli, mico and nano seconds
 * NOTE: the path passed to this function should be a c string, which means it must contain \0 at end
 */
Parser benchLexFile(const std::string_view& path, InputSource& source);

/**
 * same as benchLexFile with istream
 * benchmark lexing the filename (relative to in the current project)
 * NOTE: the path passed to this function should be a c string, which means it must contain \0 at end
 */
Parser benchLexFile(const std::string_view& path);

/**
 * will lex the file from given istream
 * NOTE: the path passed to this function should be a c string, which means it must contain \0 at end
 */
Parser lexFile(const std::string_view& path, InputSource& source);

/**
 * same as lexFile with istream
 * lex the file at path (relative to in the current project)
 * NOTE: the path passed to this function should be a c string, which means it must contain \0 at end
 */
Parser lexFile(const std::string_view& path);