style/docs: improve code style and docs

Author: alexeev-prog

CHANGELOG.md

@@ -1,3 +1,15 @@
+commit a8e8b2c77236ca2649b301f640ed99fc21863574
+Author: alexeev-prog <alexeev.dev@mail.ru>
+Date:   Sat Dec 7 00:48:16 2024 +0700
+
+    improve mnemonics structure, improve templates and segments, add color highlight
+
+commit 06a8bcdce69244a027f1b5561bd06f1279168170
+Author: alexeev-prog <alexeev.dev@mail.ru>
+Date:   Thu Dec 5 23:48:11 2024 +0700
+
+    improve docs
+
 commit 098947daf1add7002b3247f606cffb80c26fa974
 Author: alexeev-prog <alexeev.dev@mail.ru>
 Date:   Thu Dec 5 23:46:46 2024 +0700

README.md

@@ -72,6 +72,13 @@ if __name__ == "__main__":
   main()
 ```
 
+```bash
+$ fasm example.asm example
+$ ./example
+
+ Hello, World!
+```
+
 ## Check Other My Projects
 
  + [SQLSymphony](https://github.com/alexeev-prog/SQLSymphony) - simple and fast ORM in sqlite (and you can add other DBMS)

example.asm

@@ -16,30 +16,30 @@ start:                                          ; Label start with 1 commands:
 segment readable executable
 
 print_string:                                   ; Segment readable executable in FASM is a directive for defining a section of code with readable and executable attributes.
-	;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-	; Using PrintStringTemplate: Printing the string 'Hello, World!' to stdout ;
-	;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-	
-	MOV EAX, 4                                      ; Loading 4 value into EAX register.
-	MOV ECX, msg                                    ; Loading msg value into ECX register.
-	MOV EDX, msg_size                               ; Loading msg_size value into EDX register.
-	INT 128                                         ; Call software interrupt 128: SYSCALL
-	MOV EAX, 1                                      ; Loading 1 value into EAX register.
-	MOV EBX, EBX                                    ; Zeroing the EBX register using XOR
-	INT 128                                         ; Call software interrupt 128: SYSCALL
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+; Using PrintStringTemplate: Printing the string 'Hello, World!' to stdout ;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+MOV EAX, 4                                      ; Loading 4 value into EAX register.
+MOV ECX, msg                                    ; Loading msg value into ECX register.
+MOV EDX, msg_size                               ; Loading msg_size value into EDX register.
+INT 128                                         ; Call software interrupt 128: SYSCALL
+MOV EAX, 1                                      ; Loading 1 value into EAX register.
+MOV EBX, EBX                                    ; Zeroing the EBX register using XOR
+INT 128                                         ; Call software interrupt 128: SYSCALL
 
 print_string2:                                  ; Segment readable executable in FASM is a directive for defining a section of code with readable and executable attributes.
-	;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-	; Using PrintStringTemplate: Printing the string 'Hello, World!' to stdout ;
-	;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-	
-	MOV EAX, 4                                      ; Loading 4 value into EAX register.
-	MOV ECX, msg2                                   ; Loading msg2 value into ECX register.
-	MOV EDX, msg2_size                              ; Loading msg2_size value into EDX register.
-	INT 128                                         ; Call software interrupt 128: SYSCALL
-	MOV EAX, 1                                      ; Loading 1 value into EAX register.
-	MOV EBX, EBX                                    ; Zeroing the EBX register using XOR
-	INT 128                                         ; Call software interrupt 128: SYSCALL
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+; Using PrintStringTemplate: Printing the string 'Hello, World!' to stdout ;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+MOV EAX, 4                                      ; Loading 4 value into EAX register.
+MOV ECX, msg2                                   ; Loading msg2 value into ECX register.
+MOV EDX, msg2_size                              ; Loading msg2_size value into EDX register.
+INT 128                                         ; Call software interrupt 128: SYSCALL
+MOV EAX, 1                                      ; Loading 1 value into EAX register.
+MOV EBX, EBX                                    ; Zeroing the EBX register using XOR
+INT 128                                         ; Call software interrupt 128: SYSCALL
 
 
 ;; Segment readable writeable in FASM is a definition of a segment of program data codes, where the attributes readable (the contents of the segment can be read) and writeable (program commands can both read codes and change their values) are specified for it.

flexpasm/instructions/registers.py

@@ -1,7 +1,6 @@
 from enum import Enum
 from typing import Union
 
-
 from flexpasm.instructions.base import BaseRegister
 
 

flexpasm/instructions/segments.py

@@ -1,6 +1,5 @@
 from abc import ABC, abstractmethod
 
-
 from flexpasm.mnemonics.base import BaseMnemonic
 from flexpasm.settings import MAX_MESSAGE_LENGTH
 
@@ -68,8 +67,16 @@ def code(self):
 		return self._code
 
 	def set_commands_for_label(
-		self, label: str, commands: list, indentation: str = "\t"
+		self,
+		label: str,
+		commands: list,
+		indentation_level: int = 0,
 	):
+		if indentation_level == 0:
+			indentation = ""
+		else:
+			indentation = "\t" * indentation_level
+
 		result = ""
 
 		for command in commands:

flexpasm/mnemonics/arithmetic.py

@@ -1,6 +1,5 @@
 from typing import Union
 
-
 from flexpasm.instructions.base import BaseRegister
 from flexpasm.mnemonics.base import _DefaultMnemonic
 

flexpasm/mnemonics/base.py

@@ -2,7 +2,6 @@
 from enum import Enum
 from typing import Union
 
-
 from flexpasm.instructions.base import BaseRegister
 from flexpasm.rich_highlighter import Highlighter
 from flexpasm.settings import MAX_MESSAGE_LENGTH

flexpasm/mnemonics/data.py

@@ -1,6 +1,5 @@
 from typing import Union
 
-
 from flexpasm.instructions.base import BaseRegister
 from flexpasm.mnemonics.base import _DefaultMnemonic
 

flexpasm/program.py

@@ -67,7 +67,7 @@ def _post_post_warnings(self):
 	def add_label(self, label: Label):
 		print(f"[bold]Add label: {label.entry}[/bold]")
 		self._code.append(f";; Label Entry {label.entry}")
-		self._code.append(f"{label.generate()}\nf")
+		self._code.append(f"{label.generate()}\n")
 
 	def add_instruction(self, instruction: str, indentation_level: int = 0):
 		print(f"[bold]Add instruction: {instruction}[/bold]")

flexpasm/templates.py

@@ -1,6 +1,5 @@
 from abc import ABC, abstractmethod
 
-
 from flexpasm.instructions.registers import get_registers
 from flexpasm.instructions.segments import ReadableWriteableSegment
 from flexpasm.mnemonics.data import MovMnemonic
@@ -25,7 +24,12 @@ def __init__(self, string: str, var: str = "msg", entry: str = "print_string"):
 		self.var = var
 		self.entry = entry
 
-	def generate(self, mode: str, indentation: str = "\t") -> str:
+	def generate(self, mode: str, indentation_level: int = 0) -> str:
+		if indentation_level == 0:
+			indentation = ""
+		else:
+			indentation = "\t" * indentation_level
+
 		comment = self.comment()
 
 		regs = get_registers(mode)