BatchTools.h

Go to the documentation of this file.

//! @file BatchTools.h
//! Some enums for 
//////////////////////////////////////////////////////////////////////
 
#if !defined(AFX_BATCHTOOLS_H__12CD9483_C809_11D3_A382_9415BA0D2432__INCLUDED_)
#define AFX_BATCHTOOLS_H__12CD9483_C809_11D3_A382_9415BA0D2432__INCLUDED_
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
BEGIN_MOOTOOLS_NAMESPACE
 
// The value must match items order
// Do not changes the value order
//! @enum BatchSrcMode
//! @brief Can be used for defining a batch source mode.
//! @details Cf CRUNCHER_SRCMODE_PARAM BatchCruncherOptions::Parameters
typedef enum BatchSrcMode
{
    BATCHSRC_SELECTED_FILES = 0, //!< Source are selected files (might be in different folders)
    BATCHSRC_CURRENT_DIR, //!< Source is a directory unless BATCHINFO_IS_ALBUM is set
    BATCHSRC_SELECTED_DIR, //!< Source is a selected directory
} BatchSrcMode;
 
// The value must match items order
// Do not these changes the value orders
//! @enum BatchDstMode
//! @brief Can be used for defining a batch destt mode.
//! @details Cf CRUNCHER_DSTMODE_PARAM BatchCruncherOptions::Parameters
typedef enum BatchDstMode
{
    BATCHDST_SRC_DIR = 0, //!< Batch results are in src dir
    BATCHDST_SRC_SUBDIR, //!< Batch results are in sub dir of the src
    BATCHDST_NEW_DIR, //!< Batch results are in a new folder
} BatchDstMode;
 
class DLL_TOOLSFUNCTION BatchInfo
{
public:
    unsigned int srcmode; // Source mode;
    unsigned int dstmode; // Destination folder creation mode
 
    CXString srcpath; // Src path
    CXString dstpath; // Dst path
    BOOL recreatedir, recursefolders; // destination folder info
 
    typedef enum _BATCHINFO_FLAGS
    {
        BATCHINFO_NONE = 0x00,
        BATCHINFO_IS_ALBUM = 0x01, // Special mode for BATCHSRC_CURRENT_DIR
        BATCHINFO_SEL_SINGLE_DIR = 0x02, // All selected files are in same dir
        BATCHINFO_ALBUM_SINGLE_DIR = 0x04, // All album files are in same dir
 
        BATCHINFO_SELFILES_CHANGED = 0x10, // sel files changes
        BATCHINFO_ALBUMFILES_CHANGED = 0x20, // album files changes
    } BATCHINFO_FLAGS;
 
private:
    bool selFileIsAnUserChoice;
    CXStringArray selfiles, albumfiles;
    unsigned int flags;
 
    CXString GetSrcFolder(BOOL& singledir, const CXString& fileToProcess = CXString()) const;
 
public:
    BatchInfo();
 
    BOOL CanRecurseFolder(BOOL checkForDialog = FALSE) const;
    BOOL CanRecreateFolderTree(BOOL checkForDialog = FALSE) const;
 
    void SetSelFiles(const CXStringArray& files, bool userChoice); // We have a selection of files (we can use BATCHDST_SRC_SUBDIR = 0 mode) 
    void SetAlbumFiles(const CXStringArray& files); // We have an album (a set of files) when we use BATCHDST_CRUNCHER_SRCDIR_PARAM =  1, this feature is mainly use in batch dialog editor with 3DBrowser software
 
    const CXStringArray& GetSelFiles() const { return selfiles; };
    const CXStringArray& GetAlbumFiles() const { return albumfiles; };
 
    void SetAlbumMode(bool set);
    bool IsUserChoice() const { return selFileIsAnUserChoice; }
    BOOL IsAlbum() const { return !!(flags & BATCHINFO_IS_ALBUM); };
    CXString GetInformation() const;
    CXString GetDstFolder(const CXString& fileToProcess) const;
    BOOL CreateDstFolder(const CXString& fileToProcess) const;
    BOOL CheckDstFolder(BOOL showMessage) const;
};
 
END_MOOTOOLS_NAMESPACE
 
#endif // !defined(AFX_BATCHTOOLS_H__12CD9483_C809_11D3_A382_9415BA0D2432__INCLUDED_)