Logo: rename --logo-separate to --logo-position

CarterLi · CarterLi · commit 6413656ceae4 · 2024-06-27T13:49:35.000+08:00
diff --git a/doc/json_schema.json b/doc/json_schema.json
@@ -219,10 +219,15 @@
                             "description": "If true, regenerate image logo cache",
                             "default": false
                         },
-                        "separate": {
-                            "type": "boolean",
-                            "description": "If true, print modules at bottom of the logo",
-                            "default": false
+                        "position": {
+                            "type": "string",
+                            "description": "Set the position of the logo should be displayed",
+                            "enum": [
+                                "left",
+                                "top",
+                                "right"
+                            ],
+                            "default": "left"
                         },
                         "chafa": {
                             "type": "object",
diff --git a/src/data/help.json b/src/data/help.json
@@ -257,12 +257,15 @@
             }
         },
         {
-            "long": "logo-separate",
-            "desc": "If true, print modules at bottom of the logo",
+            "long": "logo-position",
+            "desc": "Set the position of the logo should be displayed",
             "arg": {
-                "type": "bool",
-                "optional": true,
-                "default": false
+                "type": "enum",
+                "enum": {
+                    "left": "Left",
+                    "top": "Top",
+                    "right": "Right"
+                }
             }
         },
         {
diff --git a/src/logo/image/image.c b/src/logo/image/image.c
@@ -72,14 +72,14 @@ static bool printImageIterm(bool printError)
 
     if (!options->width || !options->height)
     {
-        if (!options->separate)
+        if (options->position == FF_LOGO_POSITION_LEFT)
         {
             ffStrbufAppendF(&buf, "\e[2J\e[3J\e[%u;%uH",
                 (unsigned) options->paddingTop,
                 (unsigned) options->paddingLeft
             );
         }
-        else
+        else if (options->position == FF_LOGO_POSITION_TOP)
         {
             ffStrbufAppendNC(&buf, options->paddingTop, '\n');
             ffStrbufAppendNC(&buf, options->paddingLeft, ' ');
@@ -90,7 +90,7 @@ static bool printImageIterm(bool printError)
             ffStrbufAppendF(&buf, "\e]1337;File=inline=1:%s\a", base64.chars);
         ffWriteFDBuffer(FFUnixFD2NativeFD(STDOUT_FILENO), &buf);
 
-        if (!options->separate)
+        if (options->position == FF_LOGO_POSITION_LEFT)
         {
             uint16_t X = 0, Y = 0;
             const char* error = ffGetTerminalResponse("\e[6n", "\e[%hu;%huR", &Y, &X);
@@ -103,7 +103,7 @@ static bool printImageIterm(bool printError)
             instance.state.logoHeight = Y;
             fputs("\e[H", stdout);
         }
-        else
+        else if (options->position == FF_LOGO_POSITION_TOP)
         {
             instance.state.logoWidth = instance.state.logoHeight = 0;
             ffPrintCharTimes('\n', options->paddingRight);
@@ -120,13 +120,13 @@ static bool printImageIterm(bool printError)
             base64.chars
         );
 
-        if (!options->separate)
+        if (options->position == FF_LOGO_POSITION_LEFT)
         {
             instance.state.logoWidth = options->width + options->paddingLeft + options->paddingRight;
             instance.state.logoHeight = options->paddingTop + options->height;
             ffStrbufAppendF(&buf, "\e[%uA", (unsigned) instance.state.logoHeight);
         }
-        else
+        else if (options->position == FF_LOGO_POSITION_TOP)
         {
             instance.state.logoWidth = instance.state.logoHeight = 0;
             ffStrbufAppendNC(&buf, options->paddingRight, '\n');
@@ -152,15 +152,15 @@ static bool printImageKittyDirect(bool printError)
 
     if (!options->width || !options->height)
     {
-        if (!options->separate)
+        if (options->position == FF_LOGO_POSITION_LEFT)
         {
             // We must clear the entre screen to make sure that terminal buffer won't scroll up
             printf("\e[2J\e[3J\e[%u;%uH",
                 (unsigned) options->paddingTop,
                 (unsigned) options->paddingLeft
             );
         }
-        else
+        else if (options->position == FF_LOGO_POSITION_TOP)
         {
             ffPrintCharTimes('\n', options->paddingTop);
             ffPrintCharTimes(' ', options->paddingLeft);
@@ -171,7 +171,7 @@ static bool printImageKittyDirect(bool printError)
         else
             printf("\e_Ga=T,f=100,t=f;%s\e\\", base64.chars);
         fflush(stdout);
-        if (!options->separate)
+        if (options->position == FF_LOGO_POSITION_LEFT)
         {
             uint16_t X = 0, Y = 0;
             const char* error = ffGetTerminalResponse("\e[6n", "\e[%hu;%huR", &Y, &X);
@@ -184,7 +184,7 @@ static bool printImageKittyDirect(bool printError)
             instance.state.logoHeight = Y;
             fputs("\e[H", stdout);
         }
-        else
+        else if (options->position == FF_LOGO_POSITION_TOP)
         {
             instance.state.logoWidth = instance.state.logoHeight = 0;
             ffPrintCharTimes('\n', options->paddingRight);
@@ -200,13 +200,13 @@ static bool printImageKittyDirect(bool printError)
             (unsigned) options->height,
             base64.chars
         );
-        if (!options->separate)
+        if (options->position == FF_LOGO_POSITION_LEFT)
         {
             instance.state.logoWidth = options->width + options->paddingLeft + options->paddingRight;
             instance.state.logoHeight = options->paddingTop + options->height;
             printf("\e[%uA", (unsigned) instance.state.logoHeight);
         }
-        else
+        else if (options->position == FF_LOGO_POSITION_TOP)
         {
             instance.state.logoWidth = instance.state.logoHeight = 0;
             ffPrintCharTimes('\n', options->paddingRight);
diff --git a/src/logo/logo.c b/src/logo/logo.c
@@ -199,7 +199,7 @@ void ffLogoPrintChars(const char* data, bool doColorReplacement)
     if(!instance.config.display.pipe)
         ffStrbufAppendS(&result, FASTFETCH_TEXT_MODIFIER_RESET);
 
-    if(!options->separate)
+    if(options->position == FF_LOGO_POSITION_LEFT)
     {
         //Happens if the last line is the longest
         if(currentlineLength > instance.state.logoWidth)
@@ -210,7 +210,7 @@ void ffLogoPrintChars(const char* data, bool doColorReplacement)
         //Go to the leftmost position and go up the height
         ffStrbufAppendF(&result, "\e[1G\e[%uA", instance.state.logoHeight);
     }
-    else
+    else if (options->position == FF_LOGO_POSITION_TOP)
     {
         instance.state.logoWidth = instance.state.logoHeight = 0;
         ffStrbufAppendNC(&result, options->paddingRight, '\n');
diff --git a/src/options/logo.c b/src/options/logo.c
@@ -17,7 +17,7 @@ void ffOptionsInitLogo(FFOptionsLogo* options)
     options->printRemaining = true;
     options->preserveAspectRatio = false;
     options->recache = false;
-    options->separate = false;
+    options->position = FF_LOGO_POSITION_LEFT;
 
     options->chafaFgOnly = false;
     ffStrbufInitStatic(&options->chafaSymbols, "block+border+space-wide-inverted"); // Chafa default
@@ -110,8 +110,15 @@ bool ffOptionsParseLogoCommandLine(FFOptionsLogo* options, const char* key, cons
             options->preserveAspectRatio = ffOptionParseBoolean(value);
         else if(ffStrEqualsIgnCase(subKey, "recache"))
             options->recache = ffOptionParseBoolean(value);
-        else if(ffStrEqualsIgnCase(subKey, "separate"))
-            options->separate = ffOptionParseBoolean(value);
+        else if(ffStrEqualsIgnCase(subKey, "position"))
+        {
+            options->position = (FFLogoPosition) ffOptionParseEnum(key, value, (FFKeyValuePair[]) {
+                { "left", FF_LOGO_POSITION_LEFT },
+                { "right", FF_LOGO_POSITION_RIGHT },
+                { "top", FF_LOGO_POSITION_TOP },
+                {},
+            });
+        }
         else
             return false;
     }
@@ -355,9 +362,19 @@ const char* ffOptionsParseLogoJsonConfig(FFOptionsLogo* options, yyjson_val* roo
             options->recache = yyjson_get_bool(val);
             continue;
         }
-        else if (ffStrEqualsIgnCase(key, "separate"))
+        else if (ffStrEqualsIgnCase(key, "position"))
         {
-            options->separate = yyjson_get_bool(val);
+            int value;
+            const char* error = ffJsonConfigParseEnum(val, &value, (FFKeyValuePair[]) {
+                { "left", FF_LOGO_POSITION_LEFT },
+                { "top", FF_LOGO_POSITION_TOP },
+                { "right", FF_LOGO_POSITION_RIGHT },
+                {},
+            });
+
+            if (error) return error;
+            options->chafaCanvasMode = (uint32_t) value;
+
             continue;
         }
         else if (ffStrEqualsIgnCase(key, "chafa"))
@@ -528,8 +545,14 @@ void ffOptionsGenerateLogoJsonConfig(FFOptionsLogo* options, yyjson_mut_doc* doc
     if (options->recache != defaultOptions.recache)
         yyjson_mut_obj_add_bool(doc, obj, "recache", options->recache);
 
-    if (options->separate != defaultOptions.separate)
-        yyjson_mut_obj_add_bool(doc, obj, "separate", options->separate);
+    if (options->position != defaultOptions.position)
+    {
+        yyjson_mut_obj_add_str(doc, obj, "position", ((const char* []) {
+            "left",
+            "top",
+            "right",
+        })[options->position]);
+    }
 
     {
         yyjson_mut_val* chafa = yyjson_mut_obj(doc);
diff --git a/src/options/logo.h b/src/options/logo.h
@@ -23,10 +23,18 @@ typedef enum FFLogoType
     FF_LOGO_TYPE_NONE,        //--logo none
 } FFLogoType;
 
+typedef enum FFLogoPosition
+{
+    FF_LOGO_POSITION_LEFT,
+    FF_LOGO_POSITION_TOP,
+    FF_LOGO_POSITION_RIGHT,
+} FFLogoPosition;
+
 typedef struct FFOptionsLogo
 {
     FFstrbuf source;
     FFLogoType type;
+    FFLogoPosition position;
     FFstrbuf colors[FASTFETCH_LOGO_MAX_COLORS];
     uint32_t width;
     uint32_t height;
@@ -36,7 +44,6 @@ typedef struct FFOptionsLogo
     bool printRemaining;
     bool preserveAspectRatio;
     bool recache;
-    bool separate;
 
     bool chafaFgOnly;
     FFstrbuf chafaSymbols;

Original file line number	Diff line number	Diff line change
`@@ -257,12 +257,15 @@`
`257`	`257`	`}`
`258`	`258`	`},`
`259`	`259`	`{`
`260`		`- "long": "logo-separate",`
`261`		`- "desc": "If true, print modules at bottom of the logo",`
	`260`	`+ "long": "logo-position",`
	`261`	`+ "desc": "Set the position of the logo should be displayed",`
`262`	`262`	`"arg": {`
`263`		`- "type": "bool",`
`264`		`- "optional": true,`
`265`		`- "default": false`
	`263`	`+ "type": "enum",`
	`264`	`+ "enum": {`
	`265`	`+ "left": "Left",`
	`266`	`+ "top": "Top",`
	`267`	`+ "right": "Right"`
	`268`	`+ }`
`266`	`269`	`}`
`267`	`270`	`},`
`268`	`271`	`{`
Original file line number	Diff line number	Diff line change
`@@ -72,14 +72,14 @@ static bool printImageIterm(bool printError)`
`72`	`72`
`73`	`73`	`if (!options->width \|\| !options->height)`
`74`	`74`	`{`
`75`		`- if (!options->separate)`
	`75`	`+ if (options->position == FF_LOGO_POSITION_LEFT)`
`76`	`76`	`{`
`77`	`77`	`ffStrbufAppendF(&buf, "\e[2J\e[3J\e[%u;%uH",`
`78`	`78`	`(unsigned) options->paddingTop,`
`79`	`79`	`(unsigned) options->paddingLeft`
`80`	`80`	`);`
`81`	`81`	`}`
`82`		`- else`
	`82`	`+ else if (options->position == FF_LOGO_POSITION_TOP)`
`83`	`83`	`{`
`84`	`84`	`ffStrbufAppendNC(&buf, options->paddingTop, '\n');`
`85`	`85`	`ffStrbufAppendNC(&buf, options->paddingLeft, ' ');`
`@@ -90,7 +90,7 @@ static bool printImageIterm(bool printError)`
`90`	`90`	`ffStrbufAppendF(&buf, "\e]1337;File=inline=1:%s\a", base64.chars);`
`91`	`91`	`ffWriteFDBuffer(FFUnixFD2NativeFD(STDOUT_FILENO), &buf);`
`92`	`92`
`93`		`- if (!options->separate)`
	`93`	`+ if (options->position == FF_LOGO_POSITION_LEFT)`
`94`	`94`	`{`
`95`	`95`	`uint16_t X = 0, Y = 0;`
`96`	`96`	`const char* error = ffGetTerminalResponse("\e[6n", "\e[%hu;%huR", &Y, &X);`
`@@ -103,7 +103,7 @@ static bool printImageIterm(bool printError)`
`103`	`103`	`instance.state.logoHeight = Y;`
`104`	`104`	`fputs("\e[H", stdout);`
`105`	`105`	`}`
`106`		`- else`
	`106`	`+ else if (options->position == FF_LOGO_POSITION_TOP)`
`107`	`107`	`{`
`108`	`108`	`instance.state.logoWidth = instance.state.logoHeight = 0;`
`109`	`109`	`ffPrintCharTimes('\n', options->paddingRight);`
`@@ -120,13 +120,13 @@ static bool printImageIterm(bool printError)`
`120`	`120`	`base64.chars`
`121`	`121`	`);`
`122`	`122`
`123`		`- if (!options->separate)`
	`123`	`+ if (options->position == FF_LOGO_POSITION_LEFT)`
`124`	`124`	`{`
`125`	`125`	`instance.state.logoWidth = options->width + options->paddingLeft + options->paddingRight;`
`126`	`126`	`instance.state.logoHeight = options->paddingTop + options->height;`
`127`	`127`	`ffStrbufAppendF(&buf, "\e[%uA", (unsigned) instance.state.logoHeight);`
`128`	`128`	`}`
`129`		`- else`
	`129`	`+ else if (options->position == FF_LOGO_POSITION_TOP)`
`130`	`130`	`{`
`131`	`131`	`instance.state.logoWidth = instance.state.logoHeight = 0;`
`132`	`132`	`ffStrbufAppendNC(&buf, options->paddingRight, '\n');`
`@@ -152,15 +152,15 @@ static bool printImageKittyDirect(bool printError)`
`152`	`152`
`153`	`153`	`if (!options->width \|\| !options->height)`
`154`	`154`	`{`
`155`		`- if (!options->separate)`
	`155`	`+ if (options->position == FF_LOGO_POSITION_LEFT)`
`156`	`156`	`{`
`157`	`157`	`// We must clear the entre screen to make sure that terminal buffer won't scroll up`
`158`	`158`	`printf("\e[2J\e[3J\e[%u;%uH",`
`159`	`159`	`(unsigned) options->paddingTop,`
`160`	`160`	`(unsigned) options->paddingLeft`
`161`	`161`	`);`
`162`	`162`	`}`
`163`		`- else`
	`163`	`+ else if (options->position == FF_LOGO_POSITION_TOP)`
`164`	`164`	`{`
`165`	`165`	`ffPrintCharTimes('\n', options->paddingTop);`
`166`	`166`	`ffPrintCharTimes(' ', options->paddingLeft);`
`@@ -171,7 +171,7 @@ static bool printImageKittyDirect(bool printError)`
`171`	`171`	`else`
`172`	`172`	`printf("\e_Ga=T,f=100,t=f;%s\e\\", base64.chars);`
`173`	`173`	`fflush(stdout);`
`174`		`- if (!options->separate)`
	`174`	`+ if (options->position == FF_LOGO_POSITION_LEFT)`
`175`	`175`	`{`
`176`	`176`	`uint16_t X = 0, Y = 0;`
`177`	`177`	`const char* error = ffGetTerminalResponse("\e[6n", "\e[%hu;%huR", &Y, &X);`
`@@ -184,7 +184,7 @@ static bool printImageKittyDirect(bool printError)`
`184`	`184`	`instance.state.logoHeight = Y;`
`185`	`185`	`fputs("\e[H", stdout);`
`186`	`186`	`}`
`187`		`- else`
	`187`	`+ else if (options->position == FF_LOGO_POSITION_TOP)`
`188`	`188`	`{`
`189`	`189`	`instance.state.logoWidth = instance.state.logoHeight = 0;`
`190`	`190`	`ffPrintCharTimes('\n', options->paddingRight);`
`@@ -200,13 +200,13 @@ static bool printImageKittyDirect(bool printError)`
`200`	`200`	`(unsigned) options->height,`
`201`	`201`	`base64.chars`
`202`	`202`	`);`
`203`		`- if (!options->separate)`
	`203`	`+ if (options->position == FF_LOGO_POSITION_LEFT)`
`204`	`204`	`{`
`205`	`205`	`instance.state.logoWidth = options->width + options->paddingLeft + options->paddingRight;`
`206`	`206`	`instance.state.logoHeight = options->paddingTop + options->height;`
`207`	`207`	`printf("\e[%uA", (unsigned) instance.state.logoHeight);`
`208`	`208`	`}`
`209`		`- else`
	`209`	`+ else if (options->position == FF_LOGO_POSITION_TOP)`
`210`	`210`	`{`
`211`	`211`	`instance.state.logoWidth = instance.state.logoHeight = 0;`
`212`	`212`	`ffPrintCharTimes('\n', options->paddingRight);`
Original file line number	Diff line number	Diff line change
`@@ -199,7 +199,7 @@ void ffLogoPrintChars(const char* data, bool doColorReplacement)`
`199`	`199`	`if(!instance.config.display.pipe)`
`200`	`200`	`ffStrbufAppendS(&result, FASTFETCH_TEXT_MODIFIER_RESET);`
`201`	`201`
`202`		`- if(!options->separate)`
	`202`	`+ if(options->position == FF_LOGO_POSITION_LEFT)`
`203`	`203`	`{`
`204`	`204`	`//Happens if the last line is the longest`
`205`	`205`	`if(currentlineLength > instance.state.logoWidth)`
`@@ -210,7 +210,7 @@ void ffLogoPrintChars(const char* data, bool doColorReplacement)`
`210`	`210`	`//Go to the leftmost position and go up the height`
`211`	`211`	`ffStrbufAppendF(&result, "\e[1G\e[%uA", instance.state.logoHeight);`
`212`	`212`	`}`
`213`		`- else`
	`213`	`+ else if (options->position == FF_LOGO_POSITION_TOP)`
`214`	`214`	`{`
`215`	`215`	`instance.state.logoWidth = instance.state.logoHeight = 0;`
`216`	`216`	`ffStrbufAppendNC(&result, options->paddingRight, '\n');`