feat: 0.2.10 scripts accept mode argument (#59)

.github/workflows/gen-demofile.yml

@@ -29,11 +29,11 @@ jobs:
       - name: Install Pillow
         run: |
           sudo pip install Pillow
-          
+
       - name: Build ./demo
         run: |
           make
 
       - name: Try (sprites.py ./sample-sprites/alt-chest-animation) -> demofile.txt
         run: |
-          python ./scripts/sprites.py "./sample-sprites/alt-chest-animation" && echo -e "\n\033[1;32mSuccess.\e[0m\n"
+          python ./scripts/sprites.py s4c-file "./sample-sprites/alt-chest-animation" && echo -e "\n\033[1;32mSuccess.\e[0m\n"

Makefile

@@ -1,6 +1,6 @@
 export SHELL=/bin/bash
 
-VERSION= v0.2.9
+VERSION= v0.2.10
 FLAGS = -Werror -Wall -Wpedantic -Wfatal-errors
 
 all: demo

documentation/s4c.doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = "sprites4curses"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "0.2.9"
+PROJECT_NUMBER         = "0.2.10"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

s4c-animate/animate.h

@@ -7,10 +7,10 @@
 #include <ncurses.h>
 #include <pthread.h>
 
-#define S4C_ANIMATE_VERSION "0.2.9"
+#define S4C_ANIMATE_VERSION "0.2.10"
 #define S4C_ANIMATE_MAJOR_VERSION 0
 #define S4C_ANIMATE_MINOR_VERSION 2
-#define S4C_ANIMATE_PATCH_VERSION 9
+#define S4C_ANIMATE_PATCH_VERSION 10
 
 void s4c_printVersionToFile(FILE* f);
 void s4c_echoVersionToFile(FILE* f);

scripts/sheet_converter.py

@@ -49,8 +49,9 @@
 # Functions
 def usage():
     """! Prints correct invocation."""
-    print("Wrong arguments. Needed: filename, sprite width, sprite height, separator size, left corner of first sprite's X, then Y.")
-    print("\nUsage:\tpython {} <sheet_file> <sprite_width> <sprite_heigth> <separator_size> <startX> <startY".format(os.path.basename(__file__)))
+    print("Wrong arguments. Needed: mode, filename, sprite width, sprite height, separator size, left corner of first sprite's X, then Y.")
+    print("\nUsage:\tpython {} <mode> <sheet_file> <sprite_width> <sprite_heigth> <separator_size> <startX> <startY".format(os.path.basename(__file__)))
+    print("\n    mode:\n\t  s4c-file\n\t  C-header\n\t  C-impl")
 
 def color_distance(c1, c2):
     """! Calculates the distance in color between two rgb tuples.
@@ -67,16 +68,18 @@ def color_distance(c1, c2):
     distance = math.sqrt(red_distance ** 2 + green_distance ** 2 + blue_distnce ** 2)
     return distance
 
-def convert_spritesheet(filename, spriteSizeX, spriteSizeY, separatorSize, startX, startY):
+def convert_spritesheet(mode, filename, spriteSizeX, spriteSizeY, separatorSize, startX, startY):
     """! Converts a spritesheet to a 3D char array representation of pixel color and then prints it with the needed brackets and commas.
+      Depending on mode (s4c-file, C-header, C-impl) there will be a different output.
+    @param mode    The mode for output generation.
     @param filename   The input spritesheet file.
     @param spriteSizeX   The sprite width.
     @param spriteSizeY   The sprite height.
     @param separatorSize   Thickess of separator pixels.
     @param startX    X coord of left corner of first sprite.
     @param startY    Y coord of left corner of first sprite.
     """
-    target_name = os.path.splitext(os.path.basename(filename))[0]
+    target_name = os.path.splitext(os.path.basename(filename))[0].replace("-","_")
 
     sprite_size = (spriteSizeX, spriteSizeY)  # size of each sprite
     separator_size = separatorSize  # size of separator between sprites
@@ -134,7 +137,22 @@ def convert_spritesheet(filename, spriteSizeX, spriteSizeY, separatorSize, start
 
     # Start file output, beginning with version number
 
-    print("{}".format(FILE_VERSION))
+    if mode == "s4c" :
+        print("{}".format(FILE_VERSION))
+    elif mode == "header":
+        print("#ifndef {}_S4C_H_".format(target_name.upper()))
+        print("#define {}_S4C_H_".format(target_name.upper()))
+        print("#define {}_S4C_H_VERSION \"{}\"".format(target_name.upper(),FILE_VERSION))
+        print("")
+        print("/**")
+        print(" * Declares animation matrix vector for {}.".format(target_name))
+        print(" */")
+        print("extern char {}[{}][{}][{}];".format(target_name,len(sprites) +1, spriteSizeY+1, spriteSizeX +1))
+        print("\n#endif")
+        return 0
+    elif mode == "cfile":
+        print("#include \"{}.h\"\n".format(target_name))
+
     print("char {}[{}][{}][{}] = ".format(target_name,len(sprites) +1, spriteSizeY+1, spriteSizeX+1) + "{\n")
     for i, sprite in enumerate(sprites):
         print("\t//Sprite {}, index {}".format(i + 1, i))
@@ -146,16 +164,27 @@ def convert_spritesheet(filename, spriteSizeX, spriteSizeY, separatorSize, start
 
 def main(argv):
     """! Main program entry."""
-    if len(argv) != 7:
+    if len(argv) != 8:
         usage()
     else:
-        filename = argv[1]
-        spriteSizeX = int(argv[2])
-        spriteSizeY = int(argv[3])
-        separatorSize = int(argv[4])
-        startX = int(argv[5])
-        startY = int(argv[6])
-        convert_spritesheet(filename,spriteSizeX,spriteSizeY,separatorSize,startX,startY)
+        mode = argv[1]
+        if mode == "s4c-file":
+            mode = "s4c"
+        elif mode == "C-header":
+            mode = "header"
+        elif mode == "C-impl":
+            mode = "cfile"
+        else :
+            print("Error: wrong mode request")
+            usage()
+
+        filename = argv[2]
+        spriteSizeX = int(argv[3])
+        spriteSizeY = int(argv[4])
+        separatorSize = int(argv[5])
+        startX = int(argv[6])
+        startY = int(argv[7])
+        convert_spritesheet(mode,filename,spriteSizeX,spriteSizeY,separatorSize,startX,startY)
 
 if __name__ == "__main__":
     main(sys.argv)

scripts/sprites.py

@@ -51,8 +51,10 @@
 # Functions
 def usage():
     """! Prints correct invocation."""
-    print("Wrong arguments. Needed: sprites directory")
-    print("\nUsage:\tpython {}".format(os.path.basename(__file__)) + " <sprites_directory>")
+    print("Wrong arguments. Needed: mode, sprites directory")
+    print("\nUsage:\tpython {}".format(os.path.basename(__file__)) + " <mode> <sprites_directory>")
+    print("\n  mode:  \n\ts4c-file\n\tC-header\n\tC-impl")
+    exit(1)
 
 
 def color_distance(c1, c2):
@@ -117,14 +119,18 @@ def convert_sprite(file):
 
     return chars
 
-def print_converted_sprites(direc):
-    """! Takes a directory containing image file and calls convert_sprite on each one.
+def print_converted_sprites(mode, direc):
+    """! Takes a mode between (s4c, header, cfile) and a directory containing image file and calls convert_sprite on each one.
     Then it outputs all the converted sprites to stdout, including the necessary brackets to have a valid C array declaration.
+    According to the passed mode, the C header, the C file, or the version-tagged s4c-file may be generated.
     @param direc   The directory of image files to convert and print.
     """
+    if mode != "s4c" and mode != "header" and mode != "cfile" :
+        print("Unexpected mode value in print_converted_sprites: {}".format(mode))
+        usage()
     # We start the count from one so we account for one more cell for array declaration
     frames = 1
-    target_name = os.path.basename(os.path.normpath(direc))
+    target_name = os.path.basename(os.path.normpath(direc)).replace("-","_")
 
     for file in sorted(glob.glob('{}/*.png'.format(direc)),
                        key=lambda f:
@@ -137,7 +143,22 @@ def print_converted_sprites(direc):
 
     # Start file output, beginning with version number
 
-    print("{}".format(FILE_VERSION))
+    if mode == "s4c" :
+        print("{}".format(FILE_VERSION))
+    elif mode == "header":
+        print("#ifndef {}_S4C_H_".format(target_name.upper()))
+        print("#define {}_S4C_H_".format(target_name.upper()))
+        print("#define {}_S4C_H_VERSION \"{}\"".format(target_name.upper(),FILE_VERSION))
+        print("")
+        print("/**")
+        print(" * Declares animation matrix vector for {}.".format(target_name))
+        print(" */")
+        print("extern char {}[{}][{}][{}];".format(target_name,frames,ysize,xsize))
+        print("\n#endif")
+        return 0
+    elif mode == "cfile":
+        print("#include \"{}.h\"\n".format(target_name))
+
     print("char {}[{}][{}][{}] = ".format(target_name,frames,ysize,xsize) + "{\n")
     idx = 1
     for file in sorted(glob.glob('{}/*.png'.format(direc)),
@@ -156,11 +177,21 @@ def print_converted_sprites(direc):
 
 def main(argv):
     """! Main program entry."""
-    if len(argv) != 2:
+    if len(argv) != 3:
         usage()
     else:
-        directory = argv[1]
-        print_converted_sprites(directory)
+        mode = argv[1]
+        if mode == "s4c-file":
+            mode = "s4c"
+        elif mode == "C-header":
+            mode = "header"
+        elif mode == "C-impl":
+            mode = "cfile"
+        else :
+            print("Error: wrong mode request")
+            usage()
+        directory = argv[2]
+        print_converted_sprites(mode, directory)
 
 if __name__ == '__main__':
     main(sys.argv)