polserver/pol-core/bscript/compiler/file/SourceLocation.h
turleypol 7627e3d353
"Preview/Initial"- Version sourcecode formatting feature (#626)
* Squash only prettify changes from escript_formating_try

* support of "format-off" / "format-on" comments to mark areas without
formatting

* fix typo

* added FormatterIdentLevel, FormatterMergeEmptyLines cfg entry
better line splits for dicts/arrays

* added several spacing options. the current setting list is now:
//LineWidth
FormatterLineWidth 80
// keep original keyword spelling
FormatterKeepKeywords 0
// number of spaces for ident
FormatterIdentLevel 2
// multiple newlines get merged to a single
FormatterMergeEmptyLines 1
// space between emtpy parenthesis eg foo() vs foo( )
FormatterEmptyParenthesisSpacing 0
// space between emtpy brackets eg struct{} vs struct{ }
FormatterEmptyBracketSpacing 0
// space after/before parenthesis in conditionals
// eg if ( true ) vs if (true)
FormatterConditionalParenthesisSpacing 1
// space after/before parenthesis
// eg foo( true ) vs foo(true)
FormatterParenthesisSpacing 1
// space after/before brackets
// eg array{ true } vs array{true}
FormatterBracketSpacing 1
// add space after delimiter comma or semi in for loops
// eg {1, 2, 3} vs {1,2,3}
FormatterDelimiterSpacing 1
// add space around assignment
// eg a := 1; vs a:=1;
FormatterAssignmentSpacing 1
// add space around comparison
// eg a == 1 vs a==1
FormatterComparisonSpacing 1
// add space around operations
// eg a + 1 vs a+1
FormatterOperatorSpacing 1
// use \r\n as newline instead of \n
FormatterWindowsLineEndings 0

* added tab support
// use tabs instead of spaces
FormatterUseTabs 0
// tab width
FormatterTabWidth 4

* extended example ecompile.cfg with formatter settings

* cleanup

* program args comma is optional...
fixed line comments in group splitting

* since tokenids are now correct no more guessing for linecomments needed

* comments use as start tokenid the whitespace token if its on the same
line

* splitted processing from linebuilding

* renamed TokenPart to FmtToken better matches the purpose.
Comments get directly stored as FmtToken
started with a context enum

* better(?) formatting for groups

* fix eof rawlines
added check that all comments/rawlines got parsed

* const correctness

* datatype adapted to antlr

* fixed warnings

* added InsertNewlineAtEOF

* add newline at the end if the original file had one
dont strip comment whitespace if its somejind of "header block"
use the defined lineending for /* */ comments

* docs

* \r\n is default on windows \n otherwise

* fixed warning

---------

Co-authored-by: Kevin Eady <8634912+KevinEady@users.noreply.github.com>
2024-02-26 21:21:44 +01:00

76 lines
2.2 KiB
C++

#ifndef POLSERVER_SOURCELOCATION_H
#define POLSERVER_SOURCELOCATION_H
#include <fmt/format.h>
#include <string>
namespace antlr4
{
class ParserRuleContext;
class Token;
namespace tree
{
class TerminalNode;
}
} // namespace antlr4
namespace Pol::Bscript::Compiler
{
class SourceFileIdentifier;
struct Position
{
size_t line_number;
size_t character_column; // 1-based on line, as seen in an editor
size_t token_index;
};
struct Range
{
Position start;
Position end;
bool contains( const Position& ) const;
bool contains( const Range& ) const;
bool contains( size_t line_number, size_t character_column ) const;
Range( const antlr4::ParserRuleContext& );
Range( const antlr4::tree::TerminalNode& ctx );
Range( Position start, Position end );
Range( const antlr4::Token* token );
};
class SourceLocation
{
public:
SourceLocation( const SourceFileIdentifier*, size_t line_number, size_t character_column );
SourceLocation( const SourceFileIdentifier*, const Range& );
SourceLocation( const SourceFileIdentifier*, const antlr4::ParserRuleContext& );
SourceLocation( const SourceFileIdentifier*, const antlr4::tree::TerminalNode& );
SourceLocation( const SourceLocation& ) = default;
SourceLocation( SourceLocation&& ) = default;
SourceLocation& operator=( const SourceLocation& ) = delete;
~SourceLocation() = default;
void debug( const std::string& msg ) const;
[[noreturn]] void internal_error( const std::string& msg ) const;
[[noreturn]] void internal_error( const std::string& msg, const SourceLocation& related ) const;
// There is a vector of std::unique_ptr<SourceFileIdentifier> that owns
// the SourceFileIdentifier instances for a given script compilation.
// If you hold onto a SourceFileIdentifier after that vector goes
// out of scope, this will be a dangling pointer.
const SourceFileIdentifier* const source_file_identifier;
const Range range;
};
} // namespace Pol::Bscript::Compiler
template <>
struct fmt::formatter<Pol::Bscript::Compiler::SourceLocation> : fmt::formatter<std::string>
{
fmt::format_context::iterator format( const Pol::Bscript::Compiler::SourceLocation& l,
fmt::format_context& ctx ) const;
};
#endif // POLSERVER_SOURCELOCATION_H