#include <ie_imp.h>

Inheritance diagram for IE_Imp:

Public Member Functions
virtual	~IE_Imp ()
UT_Error	importFile (const char *szFilename)
UT_Error	importFile (GsfInput *input)
virtual bool	pasteFromBuffer (PD_DocumentRange pDocRange, const unsigned char pData, UT_uint32 lenData, const char *szEncoding=0)
PD_Document *	getDoc () const
void	setLoadStylesOnly (bool b)
bool	getLoadStylesOnly () const
virtual bool	supportsLoadStylesOnly ()
void	setLoadDocProps (bool b)
bool	getLoadDocProps () const
UT_Confidence_t	getFidelity () const
void	setProps (const char *props)
bool	isPasting (void) const
const std::string &	getProperty (const char *key)
Static Public Member Functions
static IEFileType	fileTypeForContents (const char *szBuf, UT_uint32 iNumbytes)
static IEFileType	fileTypeForSuffix (const char *szSuffix)
static IEFileType	fileTypeForDescription (const char *szSuffix)
static IEFileType	fileTypeForMimetype (const char *szMimetype)
static IEFileType	fileTypeForSuffixes (const char *suffixList)
static IE_ImpSniffer *	snifferForFileType (IEFileType ieft)
static const char *	suffixesForFileType (IEFileType ieft)
static const char *	descriptionForFileType (IEFileType ieft)
static UT_Error	constructImporter (PD_Document pDocument, const char szFilename, IEFileType ieft, IE_Imp *ppie, IEFileType pieft=NULL)
static UT_Error	constructImporter (PD_Document pDocument, GsfInput input, IEFileType ieft, IE_Imp *ppie, IEFileType pieft=NULL)
static UT_Error	constructImporter (PD_Document pDocument, IEFileType ieft, IE_Imp ppie, IEFileType pieft=NULL)
static bool	enumerateDlgLabels (UT_uint32 ndx, const char pszDesc, const char pszSuffixList, IEFileType *ft)
static UT_uint32	getImporterCount (void)
static void	registerImporter (IE_ImpSniffer *sniffer)
static void	unregisterImporter (IE_ImpSniffer *sniffer)
static void	unregisterAllImporters ()
static const std::vector < std::string > &	getSupportedMimeTypes ()
static const std::vector < std::string > &	getSupportedMimeClasses ()
static const std::vector < std::string > &	getSupportedSuffixes ()
static const char *	getMimeTypeForSuffix (const char *suffix)
static UT_Error	loadFile (PD_Document doc, const char szFilename, IEFileType ieft=IEFT_Unknown, const char props=NULL, IEFileType savedAsType=NULL)
static UT_Error	loadFile (PD_Document doc, GsfInput input, IEFileType ieft=IEFT_Unknown, const char props=NULL, IEFileType savedAsType=NULL)
Protected Member Functions
	IE_Imp (PD_Document *pDocument, UT_Confidence_t fidelity=0)
PT_DocPosition	getDocPos () const
void	setClipboard (PT_DocPosition dpos)
bool	isClipboard () const
virtual bool	appendStrux (PTStruxType pts, const PP_PropertyVector &attributes)
virtual bool	appendStruxFmt (pf_Frag_Strux *pfs, const PP_PropertyVector &attributes)
virtual bool	appendSpan (const UT_UCSChar *p, UT_uint32 length)
virtual bool	appendSpan (const std::string &s)
virtual bool	appendObject (PTObjectType pto, const PP_PropertyVector &attribs, const PP_PropertyVector &props=PP_NOPROPS)
bool	appendFmt (const gchar **attributes)
virtual bool	appendFmt (const PP_PropertyVector &pVecAttributes)
virtual UT_Error	_loadFile (GsfInput *input)=0
Private Types
typedef std::map< std::string, std::string >	map_type
Private Attributes
PD_Document *	m_pDocument
bool	m_isPaste
PT_DocPosition	m_dpos
bool	m_bStylesOnly
bool	m_bDocProps
map_type	m_props_map
UT_Confidence_t	m_fidelity

Member Typedef Documentation

typedef std::map<std::string, std::string> IE_Imp::map_type [private]

Constructor & Destructor Documentation

IE_Imp::~IE_Imp ( ) [virtual]

IE_Imp::IE_Imp	(	PD_Document *	pDocument,
		UT_Confidence_t	fidelity = `0`
	)			`[protected]`

References PD_Document::invalidateCache(), and m_pDocument.

Member Function Documentation

virtual UT_Error IE_Imp::_loadFile ( GsfInput * input ) [protected, pure virtual]

bool IE_Imp::appendFmt ( const gchar ** attributes ) [inline, protected]

bool IE_Imp::appendFmt ( const PP_PropertyVector & pVecAttributes ) [protected, virtual]

References PD_Document::appendFmt(), PD_Document::changeSpanFmt(), m_dpos, m_isPaste, m_pDocument, and PTC_AddFmt.

bool IE_Imp::appendObject	(	PTObjectType	pto,
		const PP_PropertyVector &	attribs,
		const PP_PropertyVector &	props = `PP_NOPROPS`
	)			`[protected, virtual]`

References PD_Document::appendObject(), PD_Document::insertObject(), m_dpos, m_isPaste, and m_pDocument.

Referenced by IE_Imp_OPML::_createBullet(), IE_Imp_AbiWord_1::_handleImage(), IE_Imp_GraphicAsDocument::_loadFile(), IE_Imp_T602::_write_fh(), IE_Imp_Psion::applyParagraphAttributes(), IE_Imp_DocBook::charData(), IE_Imp_XSL_FO::createImage(), IE_Imp_WML::createImage(), IE_Imp_DocBook::createImage(), IE_Imp_DocBook::createTitle(), IE_Imp_XSL_FO::endElement(), IE_Imp_WML::endElement(), IE_Imp_DocBook::endElement(), IE_Imp_AbiWord_1::endElement(), IE_Imp_RTF::InsertImage(), IE_Imp_Psion::insertImage(), IE_Imp_WordPerfect::openEndnote(), IE_Imp_WordPerfect::openFootnote(), IE_Imp_WordPerfect::openListElement(), IE_Imp_MSWrite::read_pic(), IE_Imp_MSWrite::read_txt(), IE_Imp_XSL_FO::startElement(), IE_Imp_WML::startElement(), IE_Imp_OPML::startElement(), IE_Imp_DocBook::startElement(), and IE_Imp_AbiWord_1::startElement().

bool IE_Imp::appendSpan ( const std::string & s ) [protected, virtual]

References appendSpan(), UT_UCS4String::length(), and UT_UCS4String::ucs4_str().

bool IE_Imp::appendSpan	(	const UT_UCSChar *	p,
		UT_uint32	length
	)			`[protected, virtual]`

References PD_Document::appendSpan(), PD_Document::insertSpan(), m_dpos, m_isPaste, and m_pDocument.

Referenced by IE_Imp_RTF::_appendSpan(), IE_Imp_KWord_1::_appendText(), IE_Imp_Applix::_applixDecodeText(), IE_Imp_Applix::_applixNewPara(), IE_Imp_Applix::_applixPageBreak(), IE_Imp_OPML::_createBullet(), IE_Imp_T602::_ins(), IE_Imp_Text::_insertSpan(), IE_Imp_StarOffice::_loadFile(), IE_Imp_Hancom::_loadFile(), IE_Imp_PalmDoc::_parseFile(), IE_Imp_ClarisWorks::_parseFile(), IE_Imp_GDA::addCell(), appendSpan(), IE_Imp_Psion::applyParagraphAttributes(), IE_Imp_XML::charData(), IE_Imp_DocBook::createTitle(), IE_Imp_DocBook::endElement(), IE_Imp_WordPerfect::insertLineBreak(), IE_Imp_WordPerfect::insertSpace(), IE_Imp_WordPerfect::insertTab(), IE_Imp_WordPerfect::insertText(), IE_Imp_RDF::insertTextWithXMLID(), IE_Imp_WordPerfect::openListElement(), IE_Imp_WordPerfect::openParagraph(), IE_Imp_MSWrite::read_txt(), IE_Imp_Psion::readParagraphs(), IE_Imp_WML::startElement(), IE_Imp_OPML::startElement(), IE_Imp_DocBook::startElement(), and IE_Imp_AbiWord_1::startElement().

bool IE_Imp::appendStrux	(	PTStruxType	pts,
		const PP_PropertyVector &	attributes
	)			`[protected, virtual]`

References PD_Document::appendStrux(), PD_Document::insertStrux(), m_dpos, m_isPaste, and m_pDocument.

bool IE_Imp::appendStruxFmt	(	pf_Frag_Strux *	pfs,
		const PP_PropertyVector &	attributes
	)			`[protected, virtual]`

References PD_Document::appendStruxFmt(), PD_Document::changeStruxFmt(), m_dpos, m_isPaste, m_pDocument, PTC_AddFmt, PTX_Block, UT_ASSERT_HARMLESS, and UT_SHOULD_NOT_HAPPEN.

Referenced by IE_Imp_Text::_insertSpan().

UT_Error IE_Imp::constructImporter	(	PD_Document *	pDocument,
		const char *	szFilename,
		IEFileType	ieft,
		IE_Imp **	ppie,
		IEFileType *	pieft = `NULL`
	)			`[static]`

Construct an importer of the right type.

Parameters:

	pDocument	Document
	szFilename	Name of file - optional
	ieft	Desired filetype - pass IEFT_Unknown for best guess
	ppie	Pointer to return importer in
	pieft	Pointer to fill in actual filetype

Caller is responsible for deleting the importer object when finished with it. This function should closely match IE_Exp::contructExporter()

References UT_go_file_open().

Referenced by AP_Win32App::_pasteFormatFromClipboard(), constructImporter(), Drop(), PD_Document::importStyles(), loadFile(), AP_UnixApp::pasteFromClipboard(), and s_pasteText().

UT_Error IE_Imp::constructImporter	(	PD_Document *	pDocument,
		GsfInput *	input,
		IEFileType	ieft,
		IE_Imp **	ppie,
		IEFileType *	pieft = `NULL`
	)			`[static]`

Construct an importer of the right type.

Parameters:

	pDocument	Document
	input,:
	ieft	Desired filetype - pass IEFT_Unknown for best guess
	ppie	Pointer to return importer in
	pieft	Pointer to fill in actual filetype

Caller is responsible for deleting the importer object when finished with it. This function should closely match IE_Exp::contructExporter()

References IE_SuffixConfidence::confidence, CONFIDENCE_THRESHOLD, constructImporter(), IE_ImpSniffer::constructImporter(), fileTypeForSuffix(), FREEP, gchar, getImporterCount(), IE_ImpSniffer::getSuffixConfidence(), IE_IMP_Sniffers, IEFT_Unknown, IEGFT_Unknown, IE_ImpSniffer::recognizeContents(), s, s_confidence_heuristic(), IE_SuffixConfidence::suffix, IE_ImpSniffer::supportsFileType(), UT_ASSERT_HARMLESS, UT_CONFIDENCE_PERFECT, UT_ERROR, UT_IE_NOMEMORY, UT_OK, and UT_return_val_if_fail.

UT_Error IE_Imp::constructImporter	(	PD_Document *	pDocument,
		IEFileType	ieft,
		IE_Imp **	ppie,
		IEFileType *	pieft = `NULL`
	)			`[static]`

Construct an importer of the right type.

Parameters:

	pDocument	Document
	ieft	Desired filetype - pass IEFT_Unknown for best guess
	ppie	Pointer to return importer in
	pieft	Pointer to fill in actual filetype

Caller is responsible for deleting the importer object when finished with it. This function should closely match IE_Exp::contructExporter()

References constructImporter().

const char * IE_Imp::descriptionForFileType ( IEFileType ieft ) [static]

Find the description for the given filetype.

Parameters:

ieft

Numerical "import filetype" ID

Returns 0 if filetype doesn't exist. This function should closely resemble IE_Imp::descriptionForFileType()

References IE_ImpSniffer::getDlgLabels(), snifferForFileType(), UT_ASSERT_HARMLESS, and UT_SHOULD_NOT_HAPPEN.

bool IE_Imp::enumerateDlgLabels	(	UT_uint32	ndx,
		const char **	pszDesc,
		const char **	pszSuffixList,
		IEFileType *	ft
	)			`[static]`

References IE_ImpSniffer::getDlgLabels(), getImporterCount(), IE_IMP_Sniffers, and s.

Referenced by AP_Win32Dialog_New::_doChoose(), AP_Win32App::_getFileTypeFromDesc(), AP_UnixDialog_New::event_ToggleOpenExisting(), AP_CocoaDialog_New::event_ToggleOpenExisting, and s_AskForPathname().

IEFileType IE_Imp::fileTypeForContents	(	const char *	szBuf,
		UT_uint32	iNumbytes
	)			`[static]`

References getImporterCount(), IE_IMP_Sniffers, IEFT_Unknown, IE_ImpSniffer::recognizeContents(), s, IE_ImpSniffer::supportsFileType(), and UT_CONFIDENCE_PERFECT.

Referenced by s_abi_widget_get_file_type(), and s_pasteText().

IEFileType IE_Imp::fileTypeForDescription ( const char * szDescription ) [static]

Find the filetype for the given filetype description.

Parameters:

szDescription

Filetype description

Returns IEFT_Unknown if no importer has this description. This function should closely resemble IE_Exp::fileTypeForDescription()

References IE_ImpSniffer::getDlgLabels(), getImporterCount(), IE_IMP_Sniffers, UT_ASSERT_HARMLESS, and UT_SHOULD_NOT_HAPPEN.

IEFileType IE_Imp::fileTypeForMimetype ( const char * szMimetype ) [static]

Find the filetype for the given mimetype.

Parameters:

szMimetype

File mimetype

Returns IEFT_Unknown if no importer knows this mimetype. Note that more than one importer may support a mimetype. We return the first one we find. This function should closely resemble IE_Exp::fileTypeForSuffix()

References IE_MimeConfidence::confidence, getImporterCount(), IE_ImpSniffer::getMimeConfidence(), IE_IMP_Sniffers, IE_MIME_MATCH_FULL, IEFT_Unknown, IE_MimeConfidence::match, IE_MimeConfidence::mimetype, s, IE_ImpSniffer::supportsFileType(), and UT_CONFIDENCE_PERFECT.

Referenced by getImportFileType(), AP_UnixApp::pasteFromClipboard(), s_abi_widget_get_file_type(), and s_pasteText().

IEFileType IE_Imp::fileTypeForSuffix ( const char * szSuffix ) [static]

Find the filetype for the given suffix.

Parameters:

szSuffix

File suffix

Returns IEFT_Unknown if no importer knows this suffix. Note that more than one importer may support a suffix. We return the first one we find. This function should closely resemble IE_Exp::fileTypeForSuffix()

References IE_SuffixConfidence::confidence, getImporterCount(), IE_ImpSniffer::getSuffixConfidence(), IE_IMP_Sniffers, IEFT_Unknown, s, IE_SuffixConfidence::suffix, IE_ImpSniffer::supportsFileType(), UT_ASSERT_HARMLESS, and UT_CONFIDENCE_PERFECT.

Referenced by AP_Win32Dialog_New::_doChoose(), AP_Win32App::_pasteFormatFromClipboard(), IE_Imp_PDF::_runConversion(), constructImporter(), Drop(), AP_UnixDialog_New::event_ToggleOpenExisting(), AP_CocoaDialog_New::event_ToggleOpenExisting, fileTypeForSuffixes(), getImportFileType(), IE_Imp_EPUB::readStructure(), s_abi_widget_get_file_type(), s_AskForPathname(), and AP_App::saveRecoveryFiles().

IEFileType IE_Imp::fileTypeForSuffixes ( const char * suffixList ) [static]

References UT_String::c_str(), fileTypeForSuffix(), IEFT_Unknown, UT_String::substr(), and UT_DEBUGMSG.

Referenced by PD_Document::_syncFileTypes().

PD_Document * IE_Imp::getDoc ( void ) const

References m_pDocument.

PT_DocPosition IE_Imp::getDocPos ( ) const [protected]

References m_dpos.

Referenced by IE_Imp_Text::_insertBlock(), IE_Imp_Text::_insertSpan(), and IE_Imp_RDF::insertTextWithXMLID().

UT_Confidence_t IE_Imp::getFidelity ( ) const [inline]

UT_uint32 IE_Imp::getImporterCount ( void ) [static]

References IE_IMP_Sniffers.

Referenced by AP_Win32Dialog_New::_doChoose(), constructImporter(), enumerateDlgLabels(), AP_UnixDialog_New::event_ToggleOpenExisting(), AP_CocoaDialog_New::event_ToggleOpenExisting, fileTypeForContents(), fileTypeForDescription(), fileTypeForMimetype(), fileTypeForSuffix(), s_AskForPathname(), and snifferForFileType().

bool IE_Imp::getLoadDocProps ( ) const [inline]

Referenced by IE_Imp_AbiWord_1::startElement().

bool IE_Imp::getLoadStylesOnly ( ) const [inline]

Referenced by IE_Imp_MsWord_97::_docProc(), IE_Imp_MsWord_97::_loadFile(), IE_Imp_RTF::_parseFile(), IE_Imp_RTF::_parseText(), IE_Imp_AbiWord_1::endElement(), IE_Imp_AbiWord_1::startElement(), IE_Imp_RTF::TranslateKeywordID(), and IE_Imp_AbiWord_1::~IE_Imp_AbiWord_1().

const char * IE_Imp::getMimeTypeForSuffix ( const char * suffix ) [static]

Map mime type to a suffix. Returns NULL if not found.

References IE_ImpSniffer::getMimeConfidence(), IE_ImpSniffer::getSuffixConfidence(), IE_IMP_Sniffers, IE_MimeConfidence::mimetype, and IE_SuffixConfidence::suffix.

Referenced by s_mapMimeToUriType().

const std::string& IE_Imp::getProperty ( const char * key ) [inline]

Referenced by IE_Imp_Text::_parseStream(), and IE_Imp_MSWrite::IE_Imp_MSWrite().

const std::vector< std::string > & IE_Imp::getSupportedMimeClasses ( ) [static]

Get supported mime classes by builtin- and plugin-filters.

References IE_IMP_MimeClasses, IE_IMP_Sniffers, IE_MIME_MATCH_CLASS, IE_MimeConfidence::match, and IE_MimeConfidence::mimetype.

const std::vector< std::string > & IE_Imp::getSupportedMimeTypes ( ) [static]

Get supported mimetypes by builtin- and plugin-filters.

References IE_IMP_MimeTypes, IE_IMP_Sniffers, IE_MIME_MATCH_FULL, IE_MimeConfidence::match, and IE_MimeConfidence::mimetype.

Referenced by s_getDragInfo().

const std::vector< std::string > & IE_Imp::getSupportedSuffixes ( ) [static]

Get supported suffixes by builtin- and plugin-filters.

References IE_IMP_Sniffers, IE_IMP_Suffixes, and IE_SuffixConfidence::suffix.

UT_Error IE_Imp::importFile ( const char * szFilename )

References _loadFile(), and UT_go_file_open().

Referenced by AbiMathView_FileInsert(), AbiCollabSessionManager::deserializeDocument(), PD_Document::importStyles(), and FV_UnixVisualDrag::mouseDrag().

UT_Error IE_Imp::importFile ( GsfInput * input )

References _loadFile().

bool IE_Imp::isClipboard ( ) const [protected]

References m_isPaste.

Referenced by IE_Imp_Text::_insertBlock(), IE_Imp_AbiWord_1::endElement(), IE_Imp_XHTML::startElement(), and IE_Imp_AbiWord_1::startElement().

bool IE_Imp::isPasting ( void ) const [inline]

Referenced by IE_Imp_Text::_insertBlock(), IE_Imp_XHTML::charData(), IE_Imp_XHTML::endElement(), IE_Imp_RTF::HandleStyleDefinition(), and IE_Imp_XHTML::startElement().

UT_Error IE_Imp::loadFile	(	PD_Document *	doc,
		const char *	szFilename,
		IEFileType	ieft = `IEFT_Unknown`,
		const char *	props = `NULL`,
		IEFileType *	savedAsType = `NULL`
	)			`[static]`

References UT_go_file_open().

Referenced by PD_Document::_importFile(), IE_Imp_PDF::_runConversion(), IE_Imp_OpenDocument::pasteFromBuffer(), and IE_Imp_EPUB::pasteFromBuffer().

UT_Error IE_Imp::loadFile	(	PD_Document *	doc,
		GsfInput *	input,
		IEFileType	ieft = `IEFT_Unknown`,
		const char *	props = `NULL`,
		IEFileType *	savedAsType = `NULL`
	)			`[static]`