exiv2app.hpp

Go to the documentation of this file.

// ***************************************************************** -*- C++ -*-
/*
 * Copyright (C) 2004-2018 Exiv2 authors
 * This program is part of the Exiv2 distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.
 */
#ifndef EXIV2APP_HPP_
#define EXIV2APP_HPP_

// *****************************************************************************
// included header files
#include <exiv2/exiv2.hpp>

#include "utils.hpp"
#include "types.hpp"
#include "getopt.hpp"

// + standard includes
#include <string>
#include <vector>
#include <set>
#include <iostream>

#ifdef EXV_HAVE_UNISTD_H
#include <unistd.h>
#endif

// stdin handler includes
#ifndef  _MSC_VER
#include <cstdlib>
#include <stdio.h>
#include <string.h>
#if defined(__CYGWIN__) || defined(__MINGW__)
#include <windows.h>
#else
#include <sys/select.h>
#endif
#endif

#if defined(_WIN32) || defined(__CYGWIN__) || defined(__MINGW__) || defined(_MSC_VER)
#include <fcntl.h>
#include <io.h>
#endif


// *****************************************************************************
// class definitions

enum CmdId { invalidCmdId, add, set, del, reg };
// enum MetadataId { invalidMetadataId, iptc, exif, xmp };
// mdNone=0, mdExif=1, mdIptc=2, mdComment=4, mdXmp=8
enum MetadataId { invalidMetadataId = Exiv2::mdNone
                , iptc = Exiv2::mdIptc
                , exif = Exiv2::mdExif
                , xmp  = Exiv2::mdXmp
                } ;

struct ModifyCmd {
    ModifyCmd() :
        cmdId_(invalidCmdId), metadataId_(invalidMetadataId),
        typeId_(Exiv2::invalidTypeId), explicitType_(false) {}
    CmdId cmdId_;                               
    std::string key_;                           
    MetadataId metadataId_;                     
    Exiv2::TypeId typeId_;                      
    bool explicitType_;
    std::string value_;                         
};
typedef std::vector<ModifyCmd> ModifyCmds;
struct CmdIdAndString {
    CmdId cmdId_;                               
    std::string cmdString_;                     
};

class Params : public Util::Getopt {
private:
    std::string optstring_;

public:
    typedef std::vector<std::string> CmdFiles;
    typedef std::vector<std::string> CmdLines;
    typedef std::vector<std::string> Files;
    typedef std::set<int> PreviewNumbers;
    typedef  exv_grep_keys_t Greps;
    typedef std::vector<std::string> Keys;

    static Params& instance();
    void cleanup();

    enum PrintMode {
        pmSummary,
        pmList,
        pmComment,
        pmPreview,
        pmStructure,
        pmXMP,
        pmIccProfile,
        pmRecursive
    };

    enum PrintItem {
        prTag   =    1,
        prGroup =    2,
        prKey   =    4,
        prName  =    8,
        prLabel =   16,
        prType  =   32,
        prCount =   64,
        prSize  =  128,
        prValue =  256,
        prTrans =  512,
        prHex   = 1024,
        prSet   = 2048
    };

    enum CommonTarget {
        ctExif       =   1,
        ctIptc       =   2,
        ctComment    =   4,
        ctThumb      =   8,
        ctXmp        =  16,
        ctXmpSidecar =  32,
        ctPreview    =  64,
        ctIccProfile = 128,
        ctXmpRaw     = 256,
        ctStdInOut   = 512,
        ctIptcRaw    =1024
    };

    enum FileExistsPolicy { overwritePolicy, renamePolicy, askPolicy };

    enum Yod { yodYear, yodMonth, yodDay };

    struct YodAdjust {
        bool        flag_;              
        const char* option_;            
        long        adjustment_;        
    };

    bool help_;                         
    bool version_;                      
    bool verbose_;                      
    bool force_;                        
    bool binary_;                       
    bool unknown_;                      
    bool preserve_;                     
    bool timestamp_;                    
    bool timestampOnly_;                
    FileExistsPolicy fileExistsPolicy_; 
    bool adjust_;                       
    PrintMode printMode_;               
    unsigned long printItems_;          
    unsigned long printTags_;           
    int  action_;
    int  target_;                       

    long adjustment_;                   
    YodAdjust yodAdjust_[3];            
    std::string format_;                
    bool formatSet_;                    
    CmdFiles cmdFiles_;                 
    CmdLines cmdLines_;                 
    ModifyCmds modifyCmds_;             
    std::string jpegComment_;           
    std::string directory_;             
    std::string suffix_;                
    Files files_;                       
    PreviewNumbers previewNumbers_;     
    Greps greps_;                       
    Keys  keys_;                        
    std::string charset_;               

    Exiv2::DataBuf  stdinBuf;           

private:
    static Params* instance_;
    static const YodAdjust emptyYodAdjust_[];

    bool first_;

private:
    Params() : optstring_(":hVvqfbuktTFa:Y:O:D:r:p:P:d:e:i:c:m:M:l:S:g:K:n:Q:"),
               help_(false),
               version_(false),
               verbose_(false),
               force_(false),
               binary_(true),
               unknown_(true),
               preserve_(false),
               timestamp_(false),
               timestampOnly_(false),
               fileExistsPolicy_(askPolicy),
               adjust_(false),
               printMode_(pmSummary),
               printItems_(0),
               printTags_(Exiv2::mdNone),
               action_(0),
               target_(ctExif|ctIptc|ctComment|ctXmp),
               adjustment_(0),
               format_("%Y%m%d_%H%M%S"),
               formatSet_(false),
               first_(true)
    {
        yodAdjust_[yodYear]  = emptyYodAdjust_[yodYear];
        yodAdjust_[yodMonth] = emptyYodAdjust_[yodMonth];
        yodAdjust_[yodDay]   = emptyYodAdjust_[yodDay];
    }

    Params(const Params& rhs);

    ~Params();


    int setLogLevel(const std::string& optarg);
    int evalGrep( const std::string& optarg);
    int evalKey( const std::string& optarg);
    int evalRename(int opt, const std::string& optarg);
    int evalAdjust(const std::string& optarg);
    int evalYodAdjust(const Yod& yod, const std::string& optarg);
    int evalPrint(const std::string& optarg);
    int evalPrintFlags(const std::string& optarg);
    int evalDelete(const std::string& optarg);
    int evalExtract(const std::string& optarg);
    int evalInsert(const std::string& optarg);
    int evalModify(int opt, const std::string& optarg);

public:
    int getopt(int argc, char* const argv[]);

    virtual int option(int opt, const std::string& optarg, int optopt);

    virtual int nonoption(const std::string& argv);

    void usage(std::ostream& os =std::cout) const;

    void help(std::ostream& os =std::cout) const;

    void version(bool verbose =false, std::ostream& os =std::cout) const;

    static std::string printTarget(const std::string& before,int target,bool bPrint=false,std::ostream& os=std::cout);

    /*
        stdin can be used by multiple images in the exiv2 command line:
        For example: $ cat foo.icc | exiv2 -iC- a.jpg b.jpg c.jpg will modify the ICC profile in several images.
    */
    void getStdin(Exiv2::DataBuf& buf);

}; // class Params

#endif                                  // #ifndef EXIV2APP_HPP_