export_filename.h

Go to the documentation of this file.

/*
    Copyright (C) 2008 Paul Davis
    Author: Sakari Bergen

    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., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_export_filename_h__
#define __ardour_export_filename_h__

#include <boost/shared_ptr.hpp>

#include <string>

#include <ardour/export_pointers.h>

#include "pbd/statefuldestructible.h"

namespace ARDOUR
{

class Session;

class LIBARDOUR_API ExportFilename {
  public:

        enum DateFormat {
                D_None,
                D_ISO,       // ISO 8601 full date
                D_ISOShortY, // Like ISO 8601, but short year representation
                D_BE,        // big endian (no deliminator)
                D_BEShortY   // big endian short year representation
        };

        enum TimeFormat {
                T_None,
                T_NoDelim,
                T_Delim
        };

  private:
        friend class ExportElementFactory;
        ExportFilename (Session & session);

  public:
        /* Serialization */

        XMLNode & get_state ();
        int set_state (const XMLNode &);

        /* data access */

        std::string get_path (ExportFormatSpecPtr format) const;
        std::string get_folder () const { return folder; }

        TimeFormat get_time_format () const { return time_format; }
        DateFormat get_date_format () const { return date_format; }
        std::string get_time_format_str (TimeFormat format) const;
        std::string get_date_format_str (DateFormat format) const;

        std::string get_label () const { return label; }
        uint32_t get_revision () const { return revision; }

        /* data modification */

        void set_time_format (TimeFormat format);
        void set_date_format (DateFormat format);
        void set_label (std::string value);
        void set_revision (uint32_t value) { revision = value; }
        void set_channel (uint32_t value) { channel = value; }
        bool set_folder (std::string path);

        void set_timespan (ExportTimespanPtr ts) { timespan = ts; }
        void set_channel_config (ExportChannelConfigPtr cc) { channel_config = cc; }

        /* public members */

        bool include_label;
        bool include_session;
        bool include_revision;
        bool include_channel_config;
        bool include_format_name;
        bool include_channel;
        bool include_timespan;
        bool include_time;
        bool include_date;

  private:

        Session & session;

        std::string   label;
        uint32_t  revision;
        uint32_t  channel;

        std::string   folder;

        DateFormat date_format;
        TimeFormat time_format;

        std::string get_formatted_time (std::string const & format) const;
        // Due to the static allocation used in strftime(), no destructor or copy-ctor is needed for this
        struct tm * time_struct;

        ExportTimespanPtr timespan;
        ExportChannelConfigPtr channel_config;

        /* Serialization helpers */

        typedef std::pair<bool, std::string> FieldPair;

        void add_field (XMLNode * node, std::string const & name, bool enabled, std::string const & value = "");
        FieldPair get_field (XMLNode const & node, std::string const & name);
        FieldPair analyse_folder ();
};


} // namespace ARDOUR

#endif /* __ardour_export_filename_h__ */