Fix global macro name and export

Author: intoinside

CONTRIBUTING.md

@@ -76,4 +76,20 @@ or output value
 
 #### Other keywords under evaluation
 * a @example keyword (optional) for pointing to other source code where method is used
-* a @note keyword (optional) for a simple usage code
+* a @note keyword (optional) for a simple usage code
+
+### Declaration case type
+Labels must use the **Snake Case with all capital letters**.
+<pre>
+.label PAGE0_PAGE_POINTER   = $D507
+</pre>
+
+Macro must use the **Pascal Case**.
+<pre>
+.macro BasicUpstart128() { }
+</pre>
+
+Functions must use the **Camel Case**.
+<pre>
+.function incArgument() { }
+</pre>

lib/cia-global.asm

@@ -47,7 +47,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_GetFirePressedPort1() { GetFirePressedPort1() }
+.macro @c128lib_GetFirePressedPort1() { GetFirePressedPort1() }
 
 /**
  * @brief Checks if the fire button is pressed on joystick port 2.
@@ -61,7 +61,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_GetFirePressedPort2() { GetFirePressedPort2() }
+.macro @c128lib_GetFirePressedPort2() { GetFirePressedPort2() }
 
 /**
  * @brief Disables the interrupts from both CIA chips.
@@ -74,5 +74,5 @@
  *
  * @since 1.1.0
  */
-.macro c128lib_DisableCIAInterrupts() { DisableCIAInterrupts() }
+.macro @c128lib_DisableCIAInterrupts() { DisableCIAInterrupts() }
 

lib/common-global.asm

@@ -64,7 +64,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_fbne(label) { fbne(label) }
+.macro @c128lib_Fbne(label) { Fbne(label) }
 
 /**
  * @brief This macro provides a far branch if minus (BMI) operation.
@@ -81,4 +81,4 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_fbmi(label) { fbmi(label) }
+.macro @c128lib_Fbmi(label) { Fbmi(label) }

lib/common.asm

@@ -33,10 +33,6 @@
 
 .filenamespace c128lib
 
-.function incArgument(arg) {
-  .return CmdArgument(arg.getType(), arg.getValue() + 1)
-}
-
 /**
  * @brief This macro sets up a BASIC program for the Commodore 128.
  *
@@ -63,6 +59,10 @@ upstartEnd:
     .pc = $1c0e "Basic End"
 }
 
+.function incArgument(arg) {
+  .return CmdArgument(arg.getType(), arg.getValue() + 1)
+}
+
 /**
  * @brief This macro provides a far branch if not equal (BNE) operation.
  *
@@ -76,11 +76,11 @@ upstartEnd:
  *
  * @param[in] label The label to jump to if the zero flag is not set.
  *
- * @note Use c128lib_fbne in common-global.asm
+ * @note Use c128lib_Fbne in common-global.asm
  *
  * @since 1.0.0
  */
-.macro fbne(label) {
+.macro Fbne(label) {
   here: // we have to add 2 to "here", because relative jump is counted right after bne xx, and this instruction takes 2 bytes
     .if (here > label) {
       // jump back
@@ -116,11 +116,11 @@ upstartEnd:
  *
  * @param[in] label The label to jump to if the negative flag is set.
  *
- * @note Use c128lib_fbmi in common-global.asm
+ * @note Use c128lib_Fbmi in common-global.asm
  *
  * @since 1.0.0
  */
- .macro fbmi(label) {
+ .macro Fbmi(label) {
   here: // we have to add 2 to "here", because relative jump is counted right after bne xx, and this instruction takes 2 bytes
     .if (here > label) {
       // jump back

lib/io-global.asm

@@ -49,7 +49,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_OpenIOChannel(filenumber, devicenumber, secondary) { OpenIOChannel(filenumber, devicenumber, secondary) }
+.macro @c128lib_OpenIOChannel(filenumber, devicenumber, secondary) { OpenIOChannel(filenumber, devicenumber, secondary) }
 
 /**
  * @brief Sets the name for I/O operations.
@@ -64,7 +64,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_SetIOName(length, address) { SetIOName(length, address) }
+.macro @c128lib_SetIOName(length, address) { SetIOName(length, address) }
 
 /**
  * @brief Sets the input channel.
@@ -79,7 +79,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_SetInputChannel(filenumber) { SetInputChannel(filenumber) }
+.macro @c128lib_SetInputChannel(filenumber) { SetInputChannel(filenumber) }
 
 /**
  * @brief Sets the output channel.
@@ -92,7 +92,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_SetOutputChannel(filenumber) { SetOutputChannel(filenumber) }
+.macro @c128lib_SetOutputChannel(filenumber) { SetOutputChannel(filenumber) }
 
 /**
  * @brief Opens a file for I/O operations.
@@ -108,4 +108,4 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_OpenFile(length, address, filenumber, devicenumber, secondary) { OpenFile(length, address, filenumber, devicenumber, secondary) }
+.macro @c128lib_OpenFile(length, address, filenumber, devicenumber, secondary) { OpenFile(length, address, filenumber, devicenumber, secondary) }

lib/math-global.asm

@@ -51,7 +51,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_Add16(value, dest) { Add16(value, dest) }
+.macro @c128lib_Add16(value, dest) { Add16(value, dest) }
 
 /**
  * @brief This macro performs a 16-bit subtraction operation.
@@ -70,7 +70,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_Sub16(value, dest) { Sub16(value, dest) }
+.macro @c128lib_Sub16(value, dest) { Sub16(value, dest) }
 
 /**
  * @brief This macro performs a 16-bit arithmetic shift left (ASL) operation.
@@ -86,7 +86,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_Asl16(address) { Asl16(address) }
+.macro @c128lib_Asl16(address) { Asl16(address) }
 
 /**
  * @brief This macro performs a 16-bit increment operation.
@@ -101,7 +101,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_Inc16(address) { Inc16(address) }
+.macro @c128lib_Inc16(address) { Inc16(address) }
 
 /**
  * @brief This macro performs a 16-bit decrement operation.
@@ -117,7 +117,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_Dec16(address) { Dec16(address) }
+.macro @c128lib_Dec16(address) { Dec16(address) }
 
 /**
  * @brief Divides a 16 bit number by a 16 bit number
@@ -134,7 +134,7 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_Div16By16(dividend, divisor, remainder) { Div16By16(dividend, divisor, remainder) }
+.macro @c128lib_Div16By16(dividend, divisor, remainder) { Div16By16(dividend, divisor, remainder) }
 
 /**
  * @brief Divides a 16 bit number by a 8 bit number
@@ -151,4 +151,4 @@
  *
  * @since 1.0.0
  */
-.macro c128lib_Div16By8(dividend, divisor, remainder) { Div16By8(dividend, divisor, remainder) }
+.macro @c128lib_Div16By8(dividend, divisor, remainder) { Div16By8(dividend, divisor, remainder) }

lib/mem-global.asm

@@ -49,17 +49,17 @@
  * @remark Register .A will be modified.
  * @remark Flags N and Z will be affected.
  *
- * @note Usage: c128lib_copyFast($C000, $C100, 256)  // Copies 256 bytes from memory location $C000 to $C100
+ * @note Usage: c128lib_CopyFast($C000, $C100, 256)  // Copies 256 bytes from memory location $C000 to $C100
  *
  * @since 1.0.0
  */
-.macro c128lib_copyFast(source, destination, count) { copyFast(source, destination, count) }
+.macro @c128lib_CopyFast(source, destination, count) { CopyFast(source, destination, count) }
 
 /**
  * @brief This macro copies a block of memory from one location to another using page relocation.
  *
  * @details This macro also handles the page relocation of the memory block during the copy operation.
- * It's slower than @sa copyFast but it uses much less memory, especially for large memory blocks copy.
+ * It's slower than @sa c128lib_CopyFast but it uses much less memory, especially for large memory blocks copy.
  *
  * @param[in] source The starting address of the memory block to be copied.
  * @param[in] destination The starting address of the location where the memory block will be copied to.
@@ -69,13 +69,13 @@
  * @remark Flags N and Z will be affected.
  * @remark Zeropage location $fe will be used.
  *
- * @note Usage: c128lib_copyWithRelocation($C000, $C100, 256)  // Copies 256 bytes from memory location $C000 to $C100 with relocation
+ * @note Usage: c128lib_CopyWithRelocation($C000, $C100, 256)  // Copies 256 bytes from memory location $C000 to $C100 with relocation
  * @note Minimum length is set to 5 because it's not convenient to use this
  * macro for lower values.
  *
  * @since 1.0.0
  */
-.macro c128lib_copyWithRelocation(source, destination, count) { copyWithRelocation(source, destination, count) }
+.macro @c128lib_CopyWithRelocation(source, destination, count) { CopyWithRelocation(source, destination, count) }
 
 /**
  * @brief This macro fills memory with a specified value.
@@ -88,11 +88,11 @@
  * @remark Registers .A and .X will be modified.
  * @remark Flags N and Z will be affected.
  *
- * @note Usage: c128lib_fillMemory($0400, $E0)  // Fills the screen starting from memory location $0400 with the value $E0
+ * @note Usage: c128lib_FillMemory($0400, $E0)  // Fills the screen starting from memory location $0400 with the value $E0
  *
  * @since 1.0.0
  */
-.macro c128lib_fillMemory(address, length, value) { fillMemory(address, length, value) }
+.macro @c128lib_FillMemory(address, length, value) { FillMemory(address, length, value) }
 
 /**
  * @brief This macro compares a 16-bit value with a 16-bit memory location.
@@ -108,11 +108,11 @@
  * @remark Register .A will be modified.
  * @remark Flags N, Z and C will be affected.
  *
- * @note Usage: cmp16($1234, $C000)  // Compares the 16-bit value $1234 with the 16-bit memory location starting at $C000
+ * @note Usage: c128lib_Cmp16($1234, $C000)  // Compares the 16-bit value $1234 with the 16-bit memory location starting at $C000
  *
  * @since 1.0.0
  */
-.macro @c128lib_cmp16(value, address) { cmp16(value, address) }
+.macro @c128lib_Cmp16(value, address) { Cmp16(value, address) }
 
 /**
  * @brief Fills two-byte located in memory address "mem" with byte "value".
@@ -125,4 +125,4 @@
  *
  * @since 1.0.0
 */
-.macro @c128lib_set16(value, address) { set16(value, address) }
+.macro @c128lib_Set16(value, address) { Set16(value, address) }