2006-01-16 22:02:54 +01:00
|
|
|
// Copyright (c) 2005, Rodrigo Braz Monteiro
|
|
|
|
// All rights reserved.
|
|
|
|
//
|
|
|
|
// Redistribution and use in source and binary forms, with or without
|
|
|
|
// modification, are permitted provided that the following conditions are met:
|
|
|
|
//
|
|
|
|
// * Redistributions of source code must retain the above copyright notice,
|
|
|
|
// this list of conditions and the following disclaimer.
|
|
|
|
// * Redistributions in binary form must reproduce the above copyright notice,
|
|
|
|
// this list of conditions and the following disclaimer in the documentation
|
|
|
|
// and/or other materials provided with the distribution.
|
|
|
|
// * Neither the name of the Aegisub Group nor the names of its contributors
|
|
|
|
// may be used to endorse or promote products derived from this software
|
|
|
|
// without specific prior written permission.
|
|
|
|
//
|
|
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
|
|
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
|
|
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
|
|
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
//
|
2009-07-29 07:43:02 +02:00
|
|
|
// Aegisub Project http://www.aegisub.org/
|
|
|
|
|
|
|
|
/// @file ass_export_filter.h
|
|
|
|
/// @see ass_export_filter.cpp
|
|
|
|
/// @ingroup export
|
|
|
|
///
|
2006-01-16 22:02:54 +01:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2013-06-08 06:19:40 +02:00
|
|
|
#include <boost/intrusive/list.hpp>
|
2010-06-24 03:24:02 +02:00
|
|
|
#include <memory>
|
2013-01-04 16:01:50 +01:00
|
|
|
#include <string>
|
2009-09-11 04:36:34 +02:00
|
|
|
|
2006-01-16 22:02:54 +01:00
|
|
|
class AssFile;
|
2013-06-08 06:19:40 +02:00
|
|
|
class AssExportFilterChain;
|
2013-01-04 16:01:50 +01:00
|
|
|
class wxWindow;
|
2011-09-28 21:46:53 +02:00
|
|
|
|
|
|
|
namespace agi { struct Context; }
|
2006-01-16 22:02:54 +01:00
|
|
|
|
2013-06-08 06:19:40 +02:00
|
|
|
class AssExportFilter : public boost::intrusive::make_list_base_hook<boost::intrusive::link_mode<boost::intrusive::auto_unlink>>::type {
|
2011-09-28 21:46:41 +02:00
|
|
|
/// The filter chain needs to be able to muck around with filter names when
|
|
|
|
/// they're registered to avoid duplicates
|
2006-01-16 22:02:54 +01:00
|
|
|
friend class AssExportFilterChain;
|
|
|
|
|
2011-01-21 07:09:04 +01:00
|
|
|
/// This filter's name
|
2013-01-04 16:01:50 +01:00
|
|
|
std::string name;
|
Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there.
This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.
Some notes:
* Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
* Some multiline comments may have been munged into single line comments
* Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
* Enum comments can go after the enumeration itself '[value] /// comment'
* include/aegisub/*.h haven't been converted yet, this will be done in a later commit
* Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.
See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.
Originally committed to SVN as r3312.
2009-07-30 00:59:22 +02:00
|
|
|
|
2011-01-21 07:09:04 +01:00
|
|
|
/// Higher priority = run earlier
|
|
|
|
int priority;
|
2006-01-16 22:02:54 +01:00
|
|
|
|
2011-01-21 07:09:04 +01:00
|
|
|
/// User-visible description of this filter
|
2013-01-04 16:01:50 +01:00
|
|
|
std::string description;
|
2006-01-16 22:02:54 +01:00
|
|
|
|
|
|
|
public:
|
2013-11-21 18:13:36 +01:00
|
|
|
AssExportFilter(std::string name, std::string description, int priority = 0);
|
2011-01-21 07:09:04 +01:00
|
|
|
virtual ~AssExportFilter() { };
|
2006-01-16 22:02:54 +01:00
|
|
|
|
2013-01-04 16:01:50 +01:00
|
|
|
std::string const& GetName() const { return name; }
|
|
|
|
std::string const& GetDescription() const { return description; }
|
2006-04-28 22:22:35 +02:00
|
|
|
|
2011-01-21 07:09:04 +01:00
|
|
|
/// Process subtitles
|
2011-09-28 21:46:41 +02:00
|
|
|
/// @param subs Subtitles to process
|
|
|
|
/// @param parent_window Window to use as the parent if the filter wishes
|
|
|
|
/// to open a progress dialog
|
2013-11-21 18:13:36 +01:00
|
|
|
virtual void ProcessSubs(AssFile *subs, wxWindow *parent_window=nullptr)=0;
|
2011-09-28 21:46:41 +02:00
|
|
|
|
2011-01-21 07:09:04 +01:00
|
|
|
/// Draw setup controls
|
2011-09-28 21:46:53 +02:00
|
|
|
/// @param parent Parent window to add controls to
|
|
|
|
/// @param c Project context
|
2013-11-21 18:13:36 +01:00
|
|
|
virtual wxWindow *GetConfigDialogWindow(wxWindow *parent, agi::Context *c) { return nullptr; }
|
2009-07-29 07:43:02 +02:00
|
|
|
|
2011-09-28 21:46:41 +02:00
|
|
|
/// Load settings to use from the configuration dialog
|
|
|
|
/// @param is_default If true use default settings instead
|
2011-09-28 21:46:53 +02:00
|
|
|
/// @param c Project context
|
|
|
|
virtual void LoadSettings(bool is_default, agi::Context *c) { }
|
2011-09-28 21:46:41 +02:00
|
|
|
};
|
2013-06-08 06:19:40 +02:00
|
|
|
|
|
|
|
typedef boost::intrusive::make_list<AssExportFilter, boost::intrusive::constant_time_size<false>>::type FilterList;
|
|
|
|
|
|
|
|
class AssExportFilterChain {
|
|
|
|
public:
|
|
|
|
/// Register an export filter
|
2013-09-16 15:43:17 +02:00
|
|
|
static void Register(std::unique_ptr<AssExportFilter> filter);
|
2013-06-08 06:19:40 +02:00
|
|
|
/// Unregister and delete all export filters
|
|
|
|
static void Clear();
|
|
|
|
/// Get a filter by name or nullptr if it doesn't exist
|
|
|
|
static AssExportFilter *GetFilter(std::string const& name);
|
|
|
|
|
|
|
|
/// Get the list of registered filters
|
|
|
|
static FilterList *GetFilterList();
|
|
|
|
};
|