kmail/kmimemagic.h

/**
 * KMimeMagic is inspired by the code of the
 * Apache Web Server.
 *
 * Rewritten for KDE by Fritz Elfert
 * fritz@kde.org
 */

#ifndef KMIMEMAGIC_H
#define KMIMEMAGIC_H

#include <qstring.h>

class KMimeMagicResult;
class KMimeMagic;

class KMimeMagicResult
{
public:
	KMimeMagicResult() {Accuracy = 100;}
	~KMimeMagicResult() {}

	void setContent(QString _content) {Content = _content;}
	void setEncoding(QString _encoding) {Encoding = _encoding;}
	void setAccuracy(int _accuracy) {Accuracy = _accuracy;}
	QString getContent() const {return Content;}
	QString getEncoding() const {return Encoding;}
	int getAccuracy() const {return Accuracy;}

private:

	QString Encoding;
	QString Content;
	int Accuracy;
};

/**
 * For every mime type
 * you can create a KMimeType. This way the program knows which
 * icon to use and which programs can handle the data.
 * Have a look at KMimeBind. Multiple extensions can be organized
 * in KMimeType ( for example *.tgz, *.tar.gz ) since they
 * mean the same document class.
 *
 * @see KMimeBind
 */
class KMimeMagic
{
public:

	/**
	 * Create a parser, initialize it with the give config file.
	 */
	KMimeMagic( const char * );

	~KMimeMagic();

	/**
	 * Merge an existing parse table with the data from the
	 * given file. Returnvalue: true on success.
	 */
	bool mergeConfig( const char * );

	/**
	 * Merge an existing parse table with the data from the
	 * given buffer. Returnvalue: true on success.
	 */
	bool mergeBufConfig(char *);

	/**
	 * Enable/Disable follow-links.
	 * (Default is off)
	 */
	void setFollowLinks( bool _enable );

	/**
	 * Tries to find a MimeType for the given file. If no special
	 * MimeType is found, the default MimeType is returned.
	 * This function looks at the content of the file.
	 */
	const KMimeMagicResult * findFileType( const char * );

	/**
	 * Same functionality as above, except data is not
	 * read from a file. Instead a buffer can be supplied which
	 * is examined. The integer parameter supplies the lenght of
	 * the buffer.
	 */
	const KMimeMagicResult * findBufferType( const char *, int );

	/**
	 * Same functionality as @ref findBufferType but with
	 * additional capability of distinguishing between
         * C-headers and C-Source.
	 */
	const KMimeMagicResult * findBufferFileType( const char *, int , const char *);

protected:

	/**
	 * The result type.
	 */
	KMimeMagicResult * magicResult;
		
private:

	/**
	 * If true, follow symlinks.
	 */
	bool followLinks;
	
	/**
	 * The current result buffer during inspection.
	 */
	QString resultBuf;

	void resultBufPrintf(char *, ...);
	int finishResult();
	void process(const char *);
	void tryit(unsigned char *, int);
	int fsmagic(const char *, struct stat *);
	int match(unsigned char *, int);
	void mprint(union VALUETYPE *, struct magic *);
	int ascmagic(unsigned char *, int);
	int softmagic(unsigned char *, int);
	const KMimeMagicResult * revision_suffix(const char *);
};

#endif