6ee2f98349
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.
162 lines
3.8 KiB
C++
162 lines
3.8 KiB
C++
// Copyright (c) 2006, 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/
|
||
//
|
||
// $Id$
|
||
|
||
/// @file subtitle_format.h
|
||
/// @see subtitle_format.cpp
|
||
/// @ingroup subtitle_io
|
||
///
|
||
|
||
|
||
#pragma once
|
||
|
||
|
||
///////////
|
||
// Headers
|
||
#include <wx/wxprec.h>
|
||
#include <wx/string.h>
|
||
#include <wx/arrstr.h>
|
||
#include <list>
|
||
|
||
|
||
//////////////
|
||
// Prototypes
|
||
class AssFile;
|
||
class AssEntry;
|
||
|
||
|
||
|
||
/// DOCME
|
||
/// @class SubtitleFormat
|
||
/// @brief DOCME
|
||
///
|
||
/// DOCME
|
||
class SubtitleFormat {
|
||
private:
|
||
|
||
/// DOCME
|
||
bool isCopy;
|
||
|
||
/// DOCME
|
||
AssFile *assFile;
|
||
|
||
void Register();
|
||
void Remove();
|
||
|
||
|
||
/// DOCME
|
||
static std::list<SubtitleFormat*> formats;
|
||
|
||
/// DOCME
|
||
static bool loaded;
|
||
|
||
protected:
|
||
|
||
/// DOCME
|
||
struct FPSRational {
|
||
|
||
/// DOCME
|
||
int num;
|
||
|
||
/// DOCME
|
||
int den;
|
||
|
||
/// DOCME
|
||
bool smpte_dropframe;
|
||
};
|
||
|
||
|
||
/// DOCME
|
||
std::list<AssEntry*> *Line;
|
||
|
||
void CreateCopy();
|
||
void ClearCopy();
|
||
void SortLines();
|
||
void ConvertTags(int format,wxString lineEnd);
|
||
//void Merge(bool identical,bool overlaps,bool stripComments,bool stripNonDialogue);
|
||
void StripComments();
|
||
void StripNonDialogue();
|
||
void RecombineOverlaps();
|
||
void MergeIdentical();
|
||
|
||
void Clear();
|
||
void LoadDefault(bool defline=true);
|
||
|
||
/// @brief DOCME
|
||
/// @return
|
||
///
|
||
AssFile *GetAssFile() { return assFile; }
|
||
int AddLine(wxString data,wxString group,int lasttime,int &version,wxString *outgroup=NULL);
|
||
FPSRational AskForFPS(bool showSMPTE=false);
|
||
|
||
virtual wxString GetName()=0;
|
||
virtual wxArrayString GetReadWildcards();
|
||
virtual wxArrayString GetWriteWildcards();
|
||
|
||
public:
|
||
SubtitleFormat();
|
||
virtual ~SubtitleFormat();
|
||
void SetTarget(AssFile *file);
|
||
|
||
static wxString GetWildcards(int mode);
|
||
|
||
|
||
/// @brief DOCME
|
||
/// @param filename
|
||
/// @return
|
||
///
|
||
virtual bool CanReadFile(wxString filename) { return false; };
|
||
|
||
/// @brief DOCME
|
||
/// @param filename
|
||
/// @return
|
||
///
|
||
virtual bool CanWriteFile(wxString filename) { return false; };
|
||
|
||
/// @brief DOCME
|
||
/// @param filename
|
||
/// @param forceEncoding=_T(<28>)
|
||
///
|
||
virtual void ReadFile(wxString filename,wxString forceEncoding=_T("")) { };
|
||
|
||
/// @brief DOCME
|
||
/// @param filename
|
||
/// @param encoding=_T(<28>)
|
||
///
|
||
virtual void WriteFile(wxString filename,wxString encoding=_T("")) { };
|
||
|
||
static SubtitleFormat *GetReader(wxString filename);
|
||
static SubtitleFormat *GetWriter(wxString filename);
|
||
static void LoadFormats();
|
||
static void DestroyFormats();
|
||
};
|
||
|
||
|