Merge pull request #19531 from kazuoteramoto/feat/roll_name_n_levels

Allow the use of multiple levels in $(ROLL.NAME[n]) variable

Author: kazuoteramoto

RELEASE_NOTES.md

@@ -201,6 +201,10 @@ changes (where available).
 - Fixed out of memory issue which could kill Darktable on small
   systems when processing large images.
 
+- Allow the variable `$(ROLL.NAME)` to have optional levels, `$(ROLL.NAME[n])`,
+  where 1 <= n <= 5, the levels follow the same rules as film roll, the default
+  value `n=1`, this keep the previous behavior of `$(ROLL.NAME)`.
+
 ## Lua
 
 ### API Version

src/common/image.c

@@ -269,10 +269,9 @@ int dt_image_monochrome_flags(const dt_image_t *img)
              | DT_IMAGE_MONOCHROME_BAYER));
 }
 
-const char *dt_image_film_roll_name(const char *path)
+const char *dt_image_film_roll_name_levels(const char *path, const int levels)
 {
   const char *folder = path + strlen(path);
-  const int numparts = CLAMPS(dt_conf_get_int("show_folder_levels"), 1, 5);
   int count = 0;
   while(folder > path)
   {
@@ -284,7 +283,7 @@ const char *dt_image_film_roll_name(const char *path)
     if(*folder == G_DIR_SEPARATOR)
 #endif
 
-      if(++count >= numparts)
+      if(++count >= levels)
       {
         ++folder;
         break;
@@ -294,6 +293,13 @@ const char *dt_image_film_roll_name(const char *path)
   return folder;
 }
 
+const char *dt_image_film_roll_name(const char *path)
+{
+  const int levels = CLAMPS(dt_conf_get_int("show_folder_levels"), 1, 5);
+
+  return dt_image_film_roll_name_levels(path, levels);
+}
+
 void dt_image_film_roll_directory(const dt_image_t *img,
                                   char *pathname,
                                   const size_t pathname_len)

src/common/image.h

@@ -409,6 +409,8 @@ void dt_image_full_path(const dt_imgid_t imgid,
 void dt_image_film_roll_directory(const dt_image_t *img,
                                   char *pathname,
                                   const size_t pathname_len);
+/** returns the portion of the path used for the film roll name, at given levels */
+const char *dt_image_film_roll_name_levels(const char *path, const int levels);
 /** returns the portion of the path used for the film roll name. */
 const char *dt_image_film_roll_name(const char *path);
 /** returns the film roll name, i.e. without the path. */

src/common/variables.c

@@ -647,7 +647,8 @@ static char *_get_base_value(dt_variables_params_t *params, char **variable)
     if(params->filename)
     {
       gchar *dirname = g_path_get_dirname(params->filename);
-      result = g_path_get_basename(dirname);
+      uint8_t levels = _get_var_parameter(variable, 1);
+      result = g_strdup(dt_image_film_roll_name_levels(dirname, CLAMPS(levels, 1, 5)));
       g_free(dirname);
     }
   }

src/gui/gtkentry.c

@@ -34,7 +34,7 @@ typedef enum
 
 
 static dt_gtkentry_completion_spec _default_path_compl_list[]
-  = { { "ROLL.NAME", N_("$(ROLL.NAME) - roll of the input image") },
+  = { { "ROLL.NAME[]", N_("$(ROLL.NAME[n]) - roll of the input image, n: levels used") },
       { "FILE.FOLDER", N_("$(FILE.FOLDER) - folder containing the input image") },
       { "FILE.NAME", N_("$(FILE.NAME) - basename of the input image") },
       { "FILE.EXTENSION", N_("$(FILE.EXTENSION) - extension of the input image") },