Merge pull request #989 from Exiv2/fix_987

Fix 987 (taglist.cpp changes)

Author: tester0077

CMakeLists.txt

@@ -105,6 +105,11 @@ endif()
 configure_file(cmake/exiv2.pc.in exiv2.pc @ONLY)
 install(FILES ${CMAKE_BINARY_DIR}/exiv2.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)
 
+# ******************************************************************************
+# Man page
+install( FILES ${PROJECT_SOURCE_DIR}/man/man1/exiv2.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 )
+
+
 include(cmake/printSummary.cmake)
 
 # That's all Folks!

README-SAMPLES.md

@@ -482,7 +482,13 @@ Test conversions from string to long, float and Rational types.
 #### taglist
 
 ```
-Usage: taglist [--group name|Groups|Exif|Canon|CanonCs|CanonSi|CanonCf|Fujifilm|Minolta|Nikon1|Nikon2|Nikon3|Olympus|Panasonic|Pentax|Sigma|Sony|Iptc|dc|xmp|xmpRights|xmpMM|xmpBJ|xmpTPg|xmpDM|pdf|photoshop|crs|tiff|exif|aux|iptc]
+$ taglist --help
+Usage: taglist [--help]
+           [--group name|
+            Groups|Exif|Canon|CanonCs|CanonSi|CanonCf|Fujifilm|Minolta|Nikon1|Nikon2|Nikon3|Olympus|
+            Panasonic|Pentax|Sigma|Sony|Iptc|
+            dc|xmp|xmpRights|xmpMM|xmpBJ|xmpTPg|xmpDM|pdf|photoshop|crs|tiff|exif|aux|iptc|all|ALL
+           ]
 Print Exif tags, MakerNote tags, or Iptc datasets
 ```
 
@@ -494,7 +500,7 @@ The data from this program is formatted as HTML on the web-site.  https://exiv2.
 For example, to show the binary definition of Group `Nikon3`:
 
 ```
-1516 rmills@rmillsmbp:~/gnu/github/exiv2/0.27-maintenance $ taglist Nikon3
+$ taglist Nikon3
 Version,    1,  0x0001, Nikon3, Exif.Nikon3.Version,    Undefined,  Nikon Makernote version
 ISOSpeed,   2,  0x0002, Nikon3, Exif.Nikon3.ISOSpeed,   Short,  ISO speed setting
 ColorMode,  3,  0x0003, Nikon3, Exif.Nikon3.ColorMode,  Ascii,  Color mode
@@ -511,15 +517,52 @@ We can see those tags being used:
 
 ```
 $ exiv2 -pa --grep Nikon3 http://clanmills.com/Stonehenge.jpg
-1519 rmills@rmillsmbp:~/gnu/github/exiv2/0.27-maintenance $ exiv2 -pa --grep Nikon3 http://clanmills.com/Stonehenge.jpg
 Exif.Nikon3.Version                          Undefined   4  2.11
 Exif.Nikon3.ISOSpeed                         Short       2  200
-1520 rmills@rmillsmbp:~/gnu/github/exiv2/0.27-maintenance $
 ...
 ```
 
 This information is formatted (search Nikon (format 3) MakerNote Tags): [https://exiv2.org/tags-nikon.html](https://exiv2.org/tags-nikon.html)
 
+#### taglist all
+
+These options are provided to list every Exif tag known to Exiv2.  The option `all` prints Group.Name for every tag.  The option `ALL` print Group.Name followed by the TagInfo for that tag.  For example:
+
+```bash
+$ taglist all | grep ISOSpeed$
+Photo.ISOSpeed
+PanasonicRaw.ISOSpeed
+CanonCs.ISOSpeed
+CanonSi.ISOSpeed
+Casio2.ISOSpeed
+MinoltaCs5D.ISOSpeed
+MinoltaCs7D.ISOSpeed
+Nikon1.ISOSpeed
+Nikon2.ISOSpeed
+Nikon3.ISOSpeed
+Olympus.ISOSpeed
+Olympus2.ISOSpeed
+```
+
+```bash
+$ taglist ALL | grep ISOSpeed,
+Photo.ISOSpeed,	34867,	0x8833,	Photo,	Exif.Photo.ISOSpeed,	Long,	This tag indicates the ISO speed value of a camera or input device that is defined in ISO 12232. When recording this tag, the PhotographicSensitivity and SensitivityType tags shall also be recorded.
+PanasonicRaw.ISOSpeed,	23,	0x0017,	PanasonicRaw,	Exif.PanasonicRaw.ISOSpeed,	Short,	ISO speed setting
+CanonCs.ISOSpeed,	16,	0x0010,	CanonCs,	Exif.CanonCs.ISOSpeed,	SShort,	ISO speed setting
+CanonSi.ISOSpeed,	2,	0x0002,	CanonSi,	Exif.CanonSi.ISOSpeed,	Short,	ISO speed used
+Casio2.ISOSpeed,	20,	0x0014,	Casio2,	Exif.Casio2.ISOSpeed,	Short,	ISO Speed
+MinoltaCs5D.ISOSpeed,	38,	0x0026,	MinoltaCs5D,	Exif.MinoltaCs5D.ISOSpeed,	Short,	ISO speed setting
+MinoltaCs7D.ISOSpeed,	28,	0x001c,	MinoltaCs7D,	Exif.MinoltaCs7D.ISOSpeed,	Short,	ISO speed setting
+Nikon1.ISOSpeed,	2,	0x0002,	Nikon1,	Exif.Nikon1.ISOSpeed,	Short,	ISO speed setting
+Nikon2.ISOSpeed,	6,	0x0006,	Nikon2,	Exif.Nikon2.ISOSpeed,	Short,	ISO speed setting
+Nikon3.ISOSpeed,	2,	0x0002,	Nikon3,	Exif.Nikon3.ISOSpeed,	Short,	ISO speed setting
+Olympus.ISOSpeed,	4097,	0x1001,	Olympus,	Exif.Olympus.ISOSpeed,	SRational,	ISO speed value
+Olympus2.ISOSpeed,	4097,	0x1001,	Olympus,	Exif.Olympus.ISOSpeed,	SRational,	ISO speed value
+Sony1MltCs7D.ISOSpeed,	28,	0x001c,	MinoltaCs7D,	Exif.MinoltaCs7D.ISOSpeed,	Short,	ISO speed setting
+```
+
+
+
 [Sample](#TOC1) Programs [Test](#TOC2) Programs
 
 <div id="tiff-test">

src/exiv2.1 renamed to man/man1/exiv2.1

@@ -2,7 +2,7 @@
 .\" First parameter, NAME, should be all caps
 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 .\" other parameters are allowed: see man(7), man(1)
-.TH EXIV2 1 "May 22, 2019"
+.TH EXIV2 1 "Aug 25, 2019"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -608,6 +608,57 @@ To register additional XMP namespaces, combine the command with:
 Empty lines and lines starting with \fB#\fP in a command file are
 ignored (comments). Remaining lines are commands as described above.
 .br
+
+
+.ne 40
+.SH EXIF TAGNAMES AND VALUES
+Exiv2 displays metadata tags and values.
+.sp 1
+The tag is a triplet of Family.Group.Tagname.  The following groups are defined for the family Exif:
+.sp 1
+.nf
+GPSInfo           Canon           Fujifilm      NikonLd1      OlympusFe1     Pentax
+Image             CanonCf                       NikonLd2      OlympusFe2     PentaxDng
+Image2            CanonCs         Nikon1        NikonLd3      OlympusFe3
+Image3            CanonF1         Nikon2        NikonMe       OlympusFe4     Samsung2
+Iop               CanonPa         Nikon3        NikonPc       OlympusFe5     SamsungPictureWizard
+MakerNote         CanonPi         NikonAFT      NikonPreview  OlympusFe6     SamsungPreview
+MpfInfo           CanonPr         NikonAf       NikonSi01xx   OlympusFe7
+Photo             CanonSi         NikonAf2      NikonSi02xx   OlympusFe8     Sony1
+SubImage1         CanonTi         NikonAf22     NikonSiD300a  OlympusFe9     Sony1Cs
+SubImage2                         NikonCb1      NikonSiD300b  OlympusFi      Sony1Cs2
+SubImage3         Casio           NikonCb2      NikonSiD40    OlympusIp      Sony1MltCs7D
+SubImage4         Casio2          NikonCb2a     NikonSiD80    OlympusRd      Sony1MltCsA100
+SubImage5                         NikonCb3      NikonVr       OlympusRd2     Sony1MltCsNew
+SubImage6         Minolta         NikonCb4      NikonWt       OlympusRi      Sony1MltCsOld
+SubImage7         MinoltaCs5D     NikonFi                                    Sony2
+SubImage8         MinoltaCs7D     NikonFl1      Olympus       Panasonic      Sony2Cs
+SubImage9         MinoltaCsNew    NikonFl2      Olympus2      PanasonicRaw   Sony2Cs2
+SubThumb1         MinoltaCsOld    NikonFl3      OlympusCs                    Sony2Fp
+Thumbnail                         NikonIi       OlympusEq     Sigma          SonyMinolta
+.fi
+.sp 1
+Exiv2 supports Exif 2.2 Standard Tags.  Exiv2 also supports reading and writing manufacturer's MakerNote.  The information in Exif.Photo.MakerNote is encoded as manufacturer's sub-records.  For example, CanonCs are Camera Settings, NikonAf are Nikon Auto Focus records, NikonCb are Nikon Color Balance Records.  Every tag is defined by a unique tagId (16 bit integer) which is unique within a Group.
+.sp
+You can query Exiv2 groups and tags with the sample program taglist which is documented in README-SAMPLES.md
+.sp
+.ne 20
+Exif Metadata values are defined in the Exif Standard.  All data is an array of data elements.  The Count defines the number elements in the array.  All elements in an array have the same type.
+.sp 1
+.nf
+Type               Explanation
+ 1 BYTE            An 8-bit unsigned integer.
+ 2 ASCII           7-bit ASCII. NUL terminated.
+ 3 SHORT           A 16-bit (2-byte) unsigned integer.
+ 4 LONG            A 32-bit (4-byte) unsigned integer
+ 5 RATIONAL        Two LONGs. Numerator, denominator.
+ 7 UNDEFINED       An 8-bit byte.
+ 8 SSHORT          A 16-bit (2-byte) signed integer.
+ 9 SLONG           A 32-bit (4-byte) signed integer.
+10 SRATIONAL       Two SLONGs. Numerator, denominator.
+.fi
+.sp
+The printing flag t = translated and is intended for human use.  Scripts should never use translated values as they are localised and the format may change as Exiv2 evolves.  The printing flag v reports the values recorded in the metadata and should be used by scripts.
 .ne 40
 .SH CONFIGURATION FILE
 Exiv2 can read an optional configuration file ~/.exiv2 on Unix systems and %USERPROFILE%\\exiv2.ini on Windows (using a Visual Studio build).  Cygwin and MinGW/msys2 follow the unix convention and use ~/.exiv2  You can fine the location of the configuration file with the command:

samples/taglist.cpp

@@ -12,42 +12,27 @@
 
 #include <iostream>
 #include <string>
+#include <sstream>
 
 using namespace Exiv2;
 
 int main(int argc, char* argv[])
 {
+    int rc = EXIT_SUCCESS;
+    std::ostringstream out;
     try {
-        int rc = 0;
+        bool bHelp     = false;
 
         switch (argc) {
             case 2: {
                 std::string item(argv[1]);
 
+                if ( item == "--help" ) {
+                    bHelp = true;
+                    break;
+                }
+
                 if (item == "Groups") {
-                   /*
-                    https://cgit.kde.org/digikam.git/tree/core/libs/dmetadata/metaengine_exif.cpp#n1077
-                    const Exiv2::GroupInfo* gi = Exiv2::ExifTags::groupList();
-
-                    while (gi->tagList_ != 0)
-                    {
-                       // NOTE: See BUG #375809 : MPF tags = exception Exiv2 0.26
-
-                       if (QLatin1String(gi->ifdName_) != QLatin1String("Makernote"))
-                       {
-                           Exiv2::TagListFct tl     = gi->tagList_;
-                           const Exiv2::TagInfo* ti = tl();
-
-                           while (ti->tag_ != 0xFFFF)
-                           {
-                               tags << ti;
-                               ++ti;
-                           }
-                       }
-
-                       ++gi;
-                    }
-                   */
                     const GroupInfo* groupList = ExifTags::groupList();
                     if (groupList) {
                         while (groupList->tagList_) {
@@ -58,6 +43,26 @@ int main(int argc, char* argv[])
                     break;
                 }
 
+                if (item == "all" || item == "ALL" ) {
+                    const GroupInfo* groupList = ExifTags::groupList();
+                    if (groupList) {
+                        std::string line;
+                        while (groupList->tagList_) {
+                            std::ostringstream tags;
+                            ExifTags::taglist(tags,groupList->groupName_);
+                            std::istringstream input(tags.str()) ;
+                            while (std::getline(input, line)) {
+                                std::cout << groupList->groupName_ << "."
+                                          << (item == "all" ? line.substr(0,line.find(",")) : line)
+                                          << std::endl;
+                            }
+                            groupList++;
+                        }
+                    }
+                    break;
+                }
+
+
                 if (item == "Exif") {
                     ExifTags::taglist(std::cout);
                     break;
@@ -78,6 +83,7 @@ int main(int argc, char* argv[])
                 } catch (const AnyError&) {
                     rc = 2;
                 }
+                std::cerr << "Unexpected argument "  << argv[1] << std::endl;
 
                 break;
             }
@@ -88,12 +94,12 @@ int main(int argc, char* argv[])
             case 3: {
                 std::string item(argv[1]);
                 std::string name(argv[2]);
-                rc = 1;  // assume unhappy ending!
+                rc = EXIT_FAILURE;  // assume unhappy ending!
 
                 if (item == "--group") {
                     if ( ExifTags::isExifGroup(name) ) {
                         ExifTags::taglist(std::cout,name);
-                        rc = 0;  // result is good
+                        rc = EXIT_SUCCESS;  // result is good
                     } else {
                         std::cerr << "warning:"
                                   << name
@@ -109,7 +115,7 @@ int main(int argc, char* argv[])
                                         std::cout << tagInfo->name_ << std::endl;
                                         tagInfo++;
                                     }
-                                    rc = 0;  // result is good
+                                    rc = EXIT_SUCCESS;  // result is good
                                 }
                                 groupList++;
                             }
@@ -119,21 +125,23 @@ int main(int argc, char* argv[])
             } break;
 
             default:
-                rc = 1;
-                break;
+                rc = EXIT_FAILURE;
+            break;
         }
 
-        if (rc) {
-            std::cout << "Usage: " << argv[0]
-                      << " [--group "
-                         "name|Groups|Exif|Canon|CanonCs|CanonSi|CanonCf|Fujifilm|Minolta|Nikon1|Nikon2|Nikon3|Olympus|"
-                         "Panasonic|Pentax|Sigma|Sony|Iptc"
-                      << "|dc|xmp|xmpRights|xmpMM|xmpBJ|xmpTPg|xmpDM|pdf|photoshop|crs|tiff|exif|aux|iptc]\n"
-                      << "Print Exif tags, MakerNote tags, or Iptc datasets\n";
+        if (rc || bHelp) {
+            std::cout << "Usage: taglist [--help]"                     << std::endl
+                << "           [--group name|"                         << std::endl
+                << "            Groups|Exif|Canon|CanonCs|CanonSi|CanonCf|Fujifilm|Minolta|Nikon1|Nikon2|Nikon3|Olympus|" << std::endl
+                << "            Panasonic|Pentax|Sigma|Sony|Iptc|"                                                        << std::endl
+                << "            dc|xmp|xmpRights|xmpMM|xmpBJ|xmpTPg|xmpDM|pdf|photoshop|crs|tiff|exif|aux|iptc|all|ALL"  << std::endl
+                << "           ]"                                      << std::endl
+                << "Print Exif tags, MakerNote tags, or Iptc datasets" << std::endl
+                ;
         }
-        return rc;
     } catch (AnyError& e) {
         std::cout << "Caught Exiv2 exception '" << e << "'\n";
-        return 1;
+        rc = EXIT_FAILURE ;
     }
+    return rc;
 }

src/CMakeLists.txt

@@ -281,9 +281,5 @@ if(EXIV2_BUILD_EXIV2_COMMAND)
     install(TARGETS exiv2 RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
 endif()
 
-# ******************************************************************************
-# Man page
-install( FILES exiv2.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 )
-
 # That's all Folks!
 ##

tests/bugfixes/github/test_issue_987.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+
+from system_tests import CaseMeta, path
+import zlib
+
+class tagListTest(metaclass=CaseMeta):
+    def compare_stdout(self, i, command, got_stdout, expected_stdout):
+        lines    = got_stdout.split('\n')
+        count    = len(lines);
+        checksum = zlib.adler32(got_stdout.encode())
+        new_got  = "%s,%s" % (count, checksum)
+        return super().compare_stdout(i, command, new_got, expected_stdout)
+
+    commands = ["$taglist --help",
+                "$taglist all",
+                "$taglist ALL",
+                "$taglist Groups",
+                "$taglist nothing",
+               ]
+    stdout =   ["8,198867862",
+                "5426,1072295739",
+                "5426,838787056",
+                "107,430791180",
+                "8,198867862",
+               ]
+
+    stderr = ["","","","","Unexpected argument nothing\n"]
+    retval = [ 0,0, 0, 0, 2]

tests/suite.conf

@@ -17,6 +17,7 @@ data_path: ../test/data
 tiff_test: ${ENV:exiv2_path}/tiff-test${ENV:binary_extension}
 largeiptc_test: ${ENV:exiv2_path}/largeiptc-test${ENV:binary_extension}
 easyaccess_test: ${ENV:exiv2_path}/easyaccess-test${ENV:binary_extension}
+taglist: ${ENV:exiv2_path}/taglist${ENV:binary_extension}
 
 [variables]
 kerFailedToReadImageData: Failed to read image data