"Preview/Initial"- Version sourcecode formatting feature

cmake/escripttest.cmake

@@ -13,9 +13,18 @@ if(NOT DEFINED ecompile)
   message(FATAL_ERROR "ecompile not defined")
 endif()
 
+# Uncomment to not delete failed formatted files (will be saved as {scriptname}.formatted.src)
+# set(keepfailedformats TRUE)
+
 function (cleanup scriptname)
-  foreach (ext .ecl .tst)
+  foreach (ext .ecl .tst .unformatted.src .formatted.src)
     if(EXISTS "${scriptname}${ext}")
+      if ("${ext}" STREQUAL ".formatted.src" AND DEFINED keepfailedformats)
+        continue()
+      endif()
+      if("${ext}" STREQUAL ".unformatted.src")
+        configure_file(${scriptname}${ext} ${scriptname}.src COPYONLY)
+      endif()
       file(REMOVE "${scriptname}${ext}")
     endif()
   endforeach()
@@ -85,15 +94,27 @@ function (checkprocfailure output errorfile result)
 endfunction()
 
 # start of test
-function (testwithcompiler)
+function (testwithcompiler formatoption)
   file(GLOB scripts RELATIVE ${testdir} ${testdir}/${subtest}/*)
   foreach(script ${scripts})
     string(FIND "${script}" ".src" out)
     if(${out} LESS 0)
       continue()
     endif()
-    message(${script})
     string(REPLACE ".src" "" scriptname "${script}")
+
+    if (EXISTS "${testdir}/${scriptname}.out" AND NOT ${formatoption} STREQUAL "")
+      message("${script} [formatted]")
+      string(REPLACE ".src" ".unformatted.src" unformattedscript "${script}")
+      configure_file(${testdir}/${script} ${testdir}/${unformattedscript} COPYONLY)
+      execute_process( COMMAND ${ecompile} ${formatoption} -q -C ecompile.cfg ${script}
+        RESULT_VARIABLE ecompile_format_res
+        OUTPUT_VARIABLE ecompile_format_out
+        ERROR_VARIABLE ecompile_format_out)
+    else()
+      message(${script})
+    endif()
+
     if (EXISTS "${testdir}/${scriptname}.out" OR EXISTS "${testdir}/${scriptname}.err")
       execute_process( COMMAND ${ecompile} -q -C ecompile.cfg ${script}
         RESULT_VARIABLE ecompile_res
@@ -112,6 +133,9 @@ function (testwithcompiler)
         endif()
       else()
         if(NOT "${ecompile_res}" STREQUAL "0")
+          if(NOT ${formatoption} STREQUAL "" AND DEFINED keepfailedformats)
+            configure_file(${testdir}/${script} ${testdir}/${scriptname}.formatted.src)
+          endif()
           cleanup(${scriptname})
           message(SEND_ERROR "${scriptname}.src did not compile")
           message(${ecompile_out})
@@ -148,4 +172,5 @@ function (testwithcompiler)
   endforeach()
 endfunction()
 
-testwithcompiler()
+testwithcompiler("")
+testwithcompiler("-Fi")

docs/docs.polserver.com/pol100/configfiles.xml

@@ -13,7 +13,7 @@
       <list>elipsis ... : repeat entries are allowed.</list>
       <bottom>This means the punctuation in these cases should NOT be in the actual config files used by POL, they only appear here for information purposes. Exception: curly braces { } are used to define an element in a config file. These must be present in the actual file.</bottom>
     </desc>
-    <datemodified>10/18/2023</datemodified>
+    <datemodified>02/26/2024</datemodified>
 </fileheader>
 
 
@@ -1042,6 +1042,24 @@ PackageRoot (path to package root)
 [EmParseTreeCacheSize (0-N {default 25})]     //Cache parse trees for this number of *.em files
 [IncParseTreeCacheSize (0-N {default 50})]    //Cache parse trees for this number of *.inc files
 
+// Formatter Options (-F -Fi)
+[FormatterLineWidth (0-N {default 80})]
+[FormatterKeepKeywords (0/1 {default 0})]                  // keep original keyword spelling
+[FormatterIdentLevel (0-N {default 2})]                    // number of spaces for ident
+[FormatterMergeEmptyLines (0/1 {default 1})]               // multiple newlines get merged to a single
+[FormatterEmptyParenthesisSpacing (0/1 {default 0})]       // space between emtpy parenthesis eg foo() vs foo( )
+[FormatterEmptyBracketSpacing (0/1 {default 0})]           // space between emtpy brackets eg struct{} vs struct{ }
+[FormatterConditionalParenthesisSpacing (0/1 {default 1})] // space after/before parenthesis in conditionals, eg if ( true ) vs if (true)
+[FormatterParenthesisSpacing (0/1 {default 1})]            // space after/before parenthesis,eg foo( true ) vs foo(true)
+[FormatterBracketSpacing (0/1 {default 1})]                // space after/before brackets,eg array{ true } vs array{true}
+[FormatterDelimiterSpacing (0/1 {default 1})]              // add space after delimiter comma or semi in for loops, eg {1, 2, 3} vs {1,2,3}
+[FormatterAssignmentSpacing (0/1 {default 1})]             // add space around assignment, eg a := 1; vs a:=1;
+[FormatterComparisonSpacing (0/1 {default 1})]             // add space around comparison, eg a == 1 vs a==1
+[FormatterOperatorSpacing (0/1 {default 1})]               // add space around operations, eg a + 1 vs a+1
+[FormatterWindowsLineEndings (0/1 {default 0/1})]            // use \r\n (windows default) as newline instead of \n (default otherwise)
+[FormatterUseTabs (0/1 {default 0})]                       // use tabs instead of spaces
+[FormatterTabWidth (0-N {default 4})]
+[FormatterInsertNewlineAtEOF (0/1 {default 0})]            // Insert a newline at end of file if missing
 </structure>
     <explain>The 'generate' properties allow default behavior for generating listing or debug files.</explain>
     <explain>If not found, ecompile will try to locate module and include directories from the system environment variables ECOMPILE_PATH_EM and ECOMPILE_PATH_INC.</explain>

docs/docs.polserver.com/pol100/corechanges.xml

@@ -2,9 +2,20 @@
 <ESCRIPT>
 	<header>
 		<topic>Latest Core Changes</topic>
-		<datemodified>02-08-2024</datemodified>
+		<datemodified>02-26-2024</datemodified>
 	</header>
 	<version name="POL100.2.0">
+		<entry>
+			<date>02-26-2024</date>
+			<author>Turley:</author>
+			<change type="Added">ecompile option -F and -Fi<br/>
+EScript formatter for .src and .inc (, .em) files, can be combined with -r and -A<br/>
+-F prints the formatted source without touching thr original files<br/>
+-Fi (inplace) formatting, rewrites the source file(s)<br/>
+ecompile.cfg.example in the distribution contains all the options currently available (or online configuration files docs)<br/>
+comments containing &quot;format-off&quot; disables the formatting until a comment containing &quot;format-on&quot; is found (or eof is reached)<br/>
+this is a very early stage of the formatter, so dont expect perfect results</change>
+		</entry>
 		<entry>
 			<date>02-08-2024</date>
 			<author>Kukkino:</author>

pol-core/bscript/CMakeSources.cmake

@@ -217,6 +217,12 @@ set (bscript_sources    # sorted !
   compiler/file/ConformingCharStream.h
   compiler/file/ErrorListener.cpp
   compiler/file/ErrorListener.h
+  compiler/file/PrettifyBuilder.cpp
+  compiler/file/PrettifyBuilder.h
+  compiler/file/PrettifyFileProcessor.cpp
+  compiler/file/PrettifyFileProcessor.h
+  compiler/file/PrettifyLineBuilder.cpp
+  compiler/file/PrettifyLineBuilder.h
   compiler/file/SourceFile.cpp
   compiler/file/SourceFile.h
   compiler/file/SourceFileCache.cpp

pol-core/bscript/compiler/Compiler.cpp

@@ -6,6 +6,7 @@
 #include "bscript/compiler/analyzer/SemanticAnalyzer.h"
 #include "bscript/compiler/astbuilder/CompilerWorkspaceBuilder.h"
 #include "bscript/compiler/codegen/CodeGenerator.h"
+#include "bscript/compiler/file/PrettifyBuilder.h"
 #include "bscript/compiler/file/SourceFileCache.h"
 #include "bscript/compiler/file/SourceFileIdentifier.h"
 #include "bscript/compiler/format/CompiledScriptSerializer.h"
@@ -127,6 +128,25 @@ void Compiler::compile_file_steps( const std::string& pathname, Report& report )
   output = generate( std::move( workspace ) );
 }
 
+bool Compiler::format_file( const std::string& filename, bool is_module, bool inplace )
+{
+  Report report( false, true );
+  PrettifyBuilder prettify_builder( profile, report );
+  auto formatted = prettify_builder.build( filename, is_module );
+  if ( report.error_count() )
+    return false;
+  if ( inplace )
+  {
+    std::ofstream filestream;
+    filestream.open( filename, std::ios_base::out | std::ios_base::trunc );
+    filestream << formatted;
+    filestream.flush();
+  }
+  else
+    INFO_PRINTLN( formatted );
+  return true;
+}
+
 std::unique_ptr<CompilerWorkspace> Compiler::build_workspace( const std::string& pathname,
                                                               Report& report )
 {

pol-core/bscript/compiler/Compiler.h

@@ -30,6 +30,7 @@ class Compiler
   void set_include_compile_mode();
 
   void compile_file_steps( const std::string& pathname, Report& );
+  bool format_file( const std::string& filename, bool is_module, bool inplace );
 
 private:
   std::unique_ptr<CompilerWorkspace> build_workspace( const std::string&, Report& );

pol-core/bscript/compiler/codegen/InstructionGenerator.cpp

@@ -72,10 +72,10 @@ namespace Pol::Bscript::Compiler
 InstructionGenerator::InstructionGenerator(
     InstructionEmitter& emitter, std::map<std::string, FlowControlLabel>& user_function_labels,
     bool in_function )
-  : emitter( emitter ),
-    emit( emitter ),
-    user_function_labels( user_function_labels ),
-    in_function( in_function )
+    : emitter( emitter ),
+      emit( emitter ),
+      user_function_labels( user_function_labels ),
+      in_function( in_function )
 {
 }
 
@@ -93,7 +93,8 @@ void InstructionGenerator::update_debug_location( const Node& node )
 
 void InstructionGenerator::update_debug_location( const SourceLocation& loc )
 {
-  emit.debug_file_line( loc.source_file_identifier->index, loc.line_number );
+  emit.debug_file_line( loc.source_file_identifier->index,
+                        static_cast<unsigned>( loc.range.start.line_number ) );
 }
 
 void InstructionGenerator::visit_array_initializer( ArrayInitializer& node )

pol-core/bscript/compiler/file/PrettifyBuilder.cpp

@@ -0,0 +1,41 @@
+#include "PrettifyBuilder.h"
+
+#include "bscript/compiler/Profile.h"
+#include "bscript/compiler/Report.h"
+#include "bscript/compiler/file/PrettifyFileProcessor.h"
+#include "bscript/compiler/file/SourceFile.h"
+#include "bscript/compiler/file/SourceFileIdentifier.h"
+#include "bscript/compiler/file/SourceLocation.h"
+
+namespace Pol::Bscript::Compiler
+{
+PrettifyBuilder::PrettifyBuilder( Profile& profile, Report& report )
+    : profile( profile ), report( report )
+{
+}
+
+std::string PrettifyBuilder::build( const std::string& pathname, bool is_module )
+{
+  auto ident = std::make_unique<SourceFileIdentifier>( 0, pathname );
+
+  SourceLocation source_location( ident.get(), 0, 0 );
+
+  auto sf = SourceFile::load( *ident, profile, report );
+
+  if ( !sf || report.error_count() )
+  {
+    report.error( *ident, "Unable to load '{}'.", pathname );
+    return {};
+  }
+  PrettifyFileProcessor prettify_processor( *ident, profile, report );
+  if ( is_module )
+    prettify_processor.process_module_unit( *sf );
+  else
+    prettify_processor.process_compilation_unit( *sf );
+
+  if ( report.error_count() )
+    return {};
+  return prettify_processor.prettify();
+}
+
+}  // namespace Pol::Bscript::Compiler

pol-core/bscript/compiler/file/PrettifyBuilder.h

@@ -0,0 +1,21 @@
+#pragma once
+
+#include <string>
+
+namespace Pol::Bscript::Compiler
+{
+class Profile;
+class Report;
+
+class PrettifyBuilder
+{
+public:
+  PrettifyBuilder( Profile&, Report& );
+
+  std::string build( const std::string& pathname, bool is_module );
+
+  Profile& profile;
+  Report& report;
+};
+
+}  // namespace Pol::Bscript::Compiler