forked from mia/Aegisub
99 lines
3.7 KiB
C++
99 lines
3.7 KiB
C++
// 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.
|
|
//
|
|
// Aegisub Project http://www.aegisub.org/
|
|
|
|
/// @file ass_export_filter.h
|
|
/// @see ass_export_filter.cpp
|
|
/// @ingroup export
|
|
///
|
|
|
|
#pragma once
|
|
|
|
#include <boost/intrusive/list.hpp>
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
class AssFile;
|
|
class AssExportFilterChain;
|
|
class wxWindow;
|
|
|
|
namespace agi { struct Context; }
|
|
|
|
class AssExportFilter : public boost::intrusive::make_list_base_hook<boost::intrusive::link_mode<boost::intrusive::auto_unlink>>::type {
|
|
/// The filter chain needs to be able to muck around with filter names when
|
|
/// they're registered to avoid duplicates
|
|
friend class AssExportFilterChain;
|
|
|
|
/// This filter's name
|
|
std::string name;
|
|
|
|
/// Higher priority = run earlier
|
|
int priority;
|
|
|
|
/// User-visible description of this filter
|
|
std::string description;
|
|
|
|
public:
|
|
AssExportFilter(std::string name, std::string description, int priority = 0);
|
|
virtual ~AssExportFilter() = default;
|
|
|
|
std::string const& GetName() const { return name; }
|
|
std::string const& GetDescription() const { return description; }
|
|
|
|
/// Process subtitles
|
|
/// @param subs Subtitles to process
|
|
/// @param parent_window Window to use as the parent if the filter wishes
|
|
/// to open a progress dialog
|
|
virtual void ProcessSubs(AssFile *subs, wxWindow *parent_window=nullptr)=0;
|
|
|
|
/// Draw setup controls
|
|
/// @param parent Parent window to add controls to
|
|
/// @param c Project context
|
|
virtual wxWindow *GetConfigDialogWindow(wxWindow *parent, agi::Context *c) { return nullptr; }
|
|
|
|
/// Load settings to use from the configuration dialog
|
|
/// @param is_default If true use default settings instead
|
|
/// @param c Project context
|
|
virtual void LoadSettings(bool is_default, agi::Context *c) { }
|
|
};
|
|
|
|
typedef boost::intrusive::make_list<AssExportFilter, boost::intrusive::constant_time_size<false>>::type FilterList;
|
|
|
|
class AssExportFilterChain {
|
|
public:
|
|
/// Register an export filter
|
|
static void Register(std::unique_ptr<AssExportFilter> filter);
|
|
/// 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();
|
|
};
|