Extend \showdate with time possibilities

Extend the `\showdate` with the possibility to specify the time

Author: albert-github

doc/commands.doc

@@ -1426,10 +1426,10 @@ contains \c TEST, or \c DEV
   for an example.
 
 <hr>
-\section cmdshowdate \\showdate "<format>" [ <date> ]
+\section cmdshowdate \\showdate "<format>" [ <date_time> ]
 
   \addindex \\showdate
-  Shows the date based on the given \<format\> and \<date\>. Where the \<format\> is a string in which the following tokens have a special meaning:
+  Shows the date and time based on the given \<format\> and \<date_time\>. Where the \<format\> is a string in which the following tokens have a special meaning:
   | Code | Description |
   | :--- | :---------- |
   | \%y | The last two decimal digits of the year. If the result is a single digit it is prefixed by 0.
@@ -1452,34 +1452,58 @@ contains \c TEST, or \c DEV
   | \%A | The full weekday name.
   | \%lA | As \%A but when not by default  the case and when possible the first character is converted to uppercase.
   | &nbsp; | &nbsp;
+  | \%H |The hour (0-23).
+  | \%0H | The hour (0-23). If the result is a single digit, it is prefixed with 0.
+  | \%I | The hour (0-11).
+  | \%0I | The hour (0-11). If the result is a single digit, it is prefixed with 0.
+  | \%M | The minute.
+  | \%0M | The minute. If the result is a single digit, it is prefixed with 0.
+  | \%S | The second.
+  | \%0S | The second. If the result is a single digit, it is prefixed with 0.
+  | &nbsp; | &nbsp;
   | \%\% | A \% character.
 
   Note that the \<format\> has to be between double quotes.
 
-  In case the \<date\> is specified it to has to have the following representation:
-  - one or 2 digits for the day
-  - a minus sign
-  - one or 2 digits for the month
-  - a minus sign
-  - 4 digits for the year
+  In case the \<date_time\> is specified it has to have the following representation:
+  - optional `date` where `date` is:
+    - one or 2 digits for the day
+    - a minus sign
+    - one or 2 digits for the month
+    - a minus sign
+    - 4 digits for the year
+  - optional `time` where `time` is:
+    - whitespace
+    - one or 2 digits for the hours
+    - a colon sign
+    - one or 2 digits for the minutes
+    - optionally
+      - a colon sign
+      - 2 digits for the seconds
   .
-  in case the \<date\> is not specified the current date is used.
+  in case the \<date_time\> is not specified the current date and time are used.
 
   Here is an example:
   \code
   - \showdate "%lA %0d-%0m-%Y" 14-3-2015
   - \showdate "%a %d-%m-%y" 14-3-2015
   - \showdate "%m.%d%y" 14-3-2015
+  - \showdate "%lA %0d-%0m-%Y %H:%M:%S" 14-3-2015 03:04:15
+  - \showdate "%lA %0d-%0m-%Y %H:%M:%S" 14-3-2015 03:04
   \endcode
   In case `OUTPUT_LANGUAGE=english` this results in:
   - Saturday 14-03-2015
   - Sat 14-3-15
   - 3.1415
+  - Saturday 14-03-15 3:4:15
+  - Saturday 14-03-15 3:4:0
   .
   In case `OUTPUT_LANGUAGE=dutch` this results in:
   - Zaterdag 14-03-15
   - za 14-3-2015
   - 3.1415
+  - Zaterdag 14-03-15 3:4:15
+  - Zaterdag 14-03-15 3:4:0
   .
 <hr>
 \section cmddeprecated \\deprecated { description }

src/docnode.cpp

@@ -3225,7 +3225,8 @@ void DocPara::handleShowDate(DocNodeVariant *thisVariant)
   parser()->tokenizer.setStateShowDate();
   tok = parser()->tokenizer.lex();
   std::tm dat = tm{};
-  if (tok == 0)
+  QCString specDate = parser()->context.token->name.stripWhiteSpace();
+  if (specDate.isEmpty())
   {
     dat = getCurrentDateTime();
   }
@@ -3237,19 +3238,66 @@ void DocPara::handleShowDate(DocNodeVariant *thisVariant)
   }
   else
   {
-    int day, month, year;
-    sscanf(parser()->context.token->name.stripWhiteSpace().data(),"%d-%d-%d", &day, &month, &year);
-    dat.tm_year = year-1900;
-    dat.tm_mon  = month-1;
-    dat.tm_mday = day;
+    int day=0, month=0, year=0;
+    int hr=0, min=0, sec=0;
+    dat = getCurrentDateTime(); // Filling with default values
+    if (sscanf(specDate.data(),"%d-%d-%d %d:%d:%d", &day, &month, &year, &hr, &min, &sec) == 6)
+    {
+      dat.tm_year = year-1900;
+      dat.tm_mon  = month-1;
+      dat.tm_mday = day;
+      dat.tm_hour = hr;
+      dat.tm_min  = min;
+      dat.tm_sec  = sec;
+    }
+    else if (sscanf(specDate.data(),"%d-%d-%d %d:%d", &day, &month, &year, &hr, &min) == 5)
+    {
+      dat.tm_year = year-1900;
+      dat.tm_mon  = month-1;
+      dat.tm_mday = day;
+      dat.tm_hour = hr;
+      dat.tm_min  = min;
+      dat.tm_sec  = 0;
+    }
+    else if (sscanf(specDate.data(),"%d-%d-%d", &day, &month, &year) == 3)
+    {
+      dat.tm_year = year-1900;
+      dat.tm_mon  = month-1;
+      dat.tm_mday = day;
+      dat.tm_hour = 0;
+      dat.tm_min  = 0;
+      dat.tm_sec  = 0;
+    }
+    else if (sscanf(specDate.data(),"%d:%d:%d", &hr, &min, &sec) == 3)
+    {
+      dat.tm_hour = hr;
+      dat.tm_min  = min;
+      dat.tm_sec  = sec;
+    }
+    else if (sscanf(specDate.data(),"%d:%d", &hr, &min) == 2)
+    {
+      dat.tm_hour = hr;
+      dat.tm_min  = min;
+      dat.tm_sec  = 0;
+    }
+    else
+    {
+      warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"invalid or non representable date argument for command '\\showdate'");
+      parser()->tokenizer.setStatePara();
+      return;
+    }
     int weekday;
+    // there are some problems when the hr:min:sec are on 00:00:00 in determining the weekday
+    hr = dat.tm_hour;
+    dat.tm_hour = 12;
     if (!valid_tm(dat,&weekday))
     {
       warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"invalid or non representable date argument for command '\\showdate'");
       parser()->tokenizer.setStatePara();
       return;
     }
     dat.tm_wday = weekday;
+    dat.tm_hour = hr;
 
   }
 
@@ -3287,6 +3335,38 @@ void DocPara::handleShowDate(DocNodeVariant *thisVariant)
                   growBuf.addStr(tmp);
                 }
                 break;
+              /* (24-)hour */
+              case 'H':
+                {
+                  char tmp[10];
+                  sprintf(tmp,"%02d",dat.tm_hour);
+                  growBuf.addStr(tmp);
+                }
+                break;
+              /* (12-)hour */
+              case 'I':
+                {
+                  char tmp[10];
+                  sprintf(tmp,"%02d",dat.tm_hour%12);
+                  growBuf.addStr(tmp);
+                }
+                break;
+              /* minute */
+              case 'M':
+                {
+                  char tmp[10];
+                  sprintf(tmp,"%02d",dat.tm_min);
+                  growBuf.addStr(tmp);
+                }
+                break;
+              /* second */
+              case 'S':
+                {
+                  char tmp[10];
+                  sprintf(tmp,"%02d",dat.tm_sec);
+                  growBuf.addStr(tmp);
+                }
+                break;
               default:
                 /* we just handle the % and 0 here */
                 p--;
@@ -3356,6 +3436,22 @@ void DocPara::handleShowDate(DocNodeVariant *thisVariant)
           case 'A':
             growBuf.addStr(theTranslator->trDayOfWeek(getDayOfWeek(dat),false,true));
             break;
+          /* (24-)hour */
+          case 'H':
+            growBuf.addStr(QCString().setNum(dat.tm_hour));
+            break;
+          /* (12-)hour */
+          case 'I':
+            growBuf.addStr(QCString().setNum(dat.tm_hour%12));
+            break;
+          /* minute */
+          case 'M':
+            growBuf.addStr(QCString().setNum(dat.tm_min));
+            break;
+          /* second */
+          case 'S':
+            growBuf.addStr(QCString().setNum(dat.tm_sec));
+            break;
           default:
             growBuf.addChar('%');
             growBuf.addChar(c);

src/doctokenizer.l

@@ -342,7 +342,7 @@ REFWORD_NOCV   {FILEMASK}|{LABELID}|{REFWORD2_NOCV}|{REFWORD3}|{REFWORD4_NOCV}
 RCSID "$"("Author"|"Date"|"Header"|"Id"|"Locker"|"Log"|"Name"|"RCSfile"|"Revision"|"Source"|"State")":"[^:\n$][^\n$]*"$"
 LINENR {BLANK}*[1-9][0-9]*
 
-SHOWDATE       [0-9][0-9]?"-"[0-9][0-9]?"-"[0-9][0-9][0-9][0-9]
+SHOWDATE ([0-9][0-9]?"-"[0-9][0-9]?"-"[0-9][0-9][0-9][0-9])?({WS}*[0-9][0-9]?":"[0-9][0-9]?(":"[0-9][0-9]?)?)?
 
 %option noyywrap