# Source: kmimemagic.h |
Annotated List
Files
Globals
Hierarchy
Index

    /* This file is part of the KDE project
       Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>

       This library is free software; you can redistribute it and/or
       modify it under the terms of the GNU Library General Public
       License as published by the Free Software Foundation; either
       version 2 of the License, or (at your option) any later version.

       This library is distributed in the hope that it will be useful,
       but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
       Library General Public License for more details.

       You should have received a copy of the GNU Library General Public License
       along with this library; see the file COPYING.LIB.  If not, write to
       the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
       Boston, MA 02111-1307, USA.
    */

    /**
     * KMimeMagic is inspired by the code of the
     * Apache Web Server.
     *
     * Rewritten for KDE by Fritz Elfert
     * fritz@kde.org
     * Adaptations by Torben Weis <weis@kde.org>
     * Fixes and documentation by David Faure <faure@kde.org>
     */

    #ifndef KMIMEMAGIC_H
    #define KMIMEMAGIC_H

    #include <qstring.h>

    class KMimeMagic; // see below (read this one first)

    /**
     * Returned by @ref KMimeMagic @p find...Type methods.
     *
     * It contains the mimetype and the encoding of
     * the file or buffer read.
     */
    class KMimeMagicResult
    {
    public:
      KMimeMagicResult() { m_iAccuracy = 100; }
      ~KMimeMagicResult() { }

      /**
       * Retrieve the mimetype (e.g. "text/html") of the file or buffer parsed.
       */
      const QString mimeType() { return m_strMimeType; }
      /**
       * Retrieve the encoding (e.g. "8bit", see 'magic' file) of the file or buffer parsed.
       */
      const QString encoding() { return m_strEncoding; }
      /**
       * Retrievee the accuracy of the matching.
       */
      int accuracy() { return m_iAccuracy; }
      /**
       * Returns whether the result is valid (i.e. mimetype not empty).
       */
      bool isValid() { return !m_strMimeType.isEmpty(); }

      /////////////////
      // Internal functions only
      /////////////////
      void setMimeType( const QString& _mime ) { m_strMimeType = _mime; }
      void setEncoding( const QString& _encoding) { m_strEncoding = _encoding;}
      void setAccuracy( int _accuracy ) { m_iAccuracy = _accuracy; }
      void setInvalid() { m_strMimeType = ""; }

    protected:
      QString m_strEncoding;
      QString m_strMimeType;
      int m_iAccuracy;
    };

    /**
     * Determine auto-magically the type of file,
     * not only by using its extension, but also by reading its contents.
     *
     *
     * Unless specified otherwise, @ref KMimeMagic uses
     * $KDEDIR/share/mimelnk/magic for this purpose.
     *
     * The basic usage of @ref KMimeMagic is :
     * @li Get a pointer to it, using @ref KMimeMagic::self().
     * @li Use it for any file or buffer you want, using one of the three
     * @p find...Type() methods.
     *
     * The result is contained in the class @ref KMimeMagicResult.
     */
    class KMimeMagic
    {
    public:
      /**
       * Create a parser and initialize it with the given config file.
       */
      KMimeMagic( const QString & configFile );

      /**
       * Destroy the parser.
       */
      ~KMimeMagic();

      /**
       * Merge an existing parse table with the data from the
       * given file.
       *
       * @return @p true on success.
       */
      bool mergeConfig( const QString & configFile );

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

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

      /**
       * Try 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.
       *
       * @return A pointer to the result object. Do @em not delete the
       *         result object. After another call to KMimeMagic
       *         the returned result object changes its value
       *         since it is reused by KMimeMagic.
       */
      KMimeMagicResult* findFileType( const QString & _filename );

      /**
       * 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 length of
       * the buffer.
       *
       * @return A pointer to the result object. Do @em not delete the
       *         result object. After another call to KMimeMagic
       *         the returned result object changes its value
       *         since it is reused by KMimeMagic.
       */
      KMimeMagicResult* findBufferType( const QByteArray &p );

      /**
       * Same functionality as @ref findBufferType() but with
       * additional capability of distinguishing between
       * C-headers and C-Source.
       *
       * For this purpose this function looks
       * at the extension of the filename. This means that 'filename'
       * can be a filename on some FTP server, too.
       *
       * @return A pointer to the result object. Do @em not delete the
       *         result object. After another call to KMimeMagic
       *         the returned result object changes its value
       *         since it is reused by KMimeMagic.
       */
      KMimeMagicResult * findBufferFileType( const QByteArray &, const QString & filename );

      /**
       * Returns a pointer to the unique @ref KMimeMagic instance in this process.
       */
      static KMimeMagic* self();

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

      static void initStatic();
      static KMimeMagic* s_pSelf;

    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 parse_line(char *line, int *rule, int lineno);
      int parse(char *, int);
      int buff_apprentice(char*buff);
      int apprentice();
      int ascmagic(unsigned char *, int);
      int internatmagic(unsigned char *, int);
      int softmagic(unsigned char *, int);

      struct config_rec *conf;
      int accuracy;
    };

    #endif

Generated by: root@sparc.ports.openbsd.org on Wed May 2 09:40:40 2001, using kdoc 2.0a53.