ut_text.h

Go to the documentation of this file.

/***************************************************************************
 *            ut_text.h
 *
 *  Tue Oct  5 11:28:11 2004
 *  Copyright  2004  Alliance MCA
 *  Written by : Antoine Calando (antoine@alliancemca.net)
 ****************************************************************************/

/*
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */
 
#ifndef _UT_TEXT_H_
#define _UT_TEXT_H_



/***************************************************************************/
typedef enum UtTextFlags {
        UT_F_UNSET                               = 0,
        UT_F_FORCE_BINARY                = 1<<0, 
        UT_F_IDENTIFY_EOL                = 1<<1, 
        UT_F_TRANSFORM_EOL               = 1<<2, 
        UT_F_REMOVE_ILLEGAL_CHAR = 1<<3, 
        UT_F_ADD_FINAL_EOL               = 1<<4, 
        UT_F_IDENTIFY_CHARSET    = 1<<5,
        UT_F_REFERENCE_EXT_CHAR  = 1<<6, 

        UT_F_DEFAULT = UT_F_REMOVE_ILLEGAL_CHAR | UT_F_IDENTIFY_CHARSET
} UtTextFlags;

/***************************************************************************/
typedef enum UtPassFlags {
        UT_PF_UNSET             = 0,
        UT_PF_NONE                      = 1<<0,
        UT_PF_LOAD                      = 1<<1,
        UT_PF_RECOGNIZE         = 1<<2,
        UT_PF_DISTRIB_PASS      = 1<<3,
        UT_PF_EOL_PASS          = 1<<4,
        UT_PF_XASCII_PASS       = 1<<5,
        UT_PF_CONVERT           = 1<<6,

        UT_PF_MAX                       = 1<<6
        //UT_PF_ALL                     = UT_PF_LOAD | UT_PF_RECOGNIZE | UT_PF_CONVERT
} UtPassFlags;

        



/***************************************************************************/
typedef struct UtCharsetEval {
        long rating;    
        ulong checksum; 
} UtCharsetEval;


/***************************************************************************/
typedef struct UtExtCharLine {
        char * line_p;          
        ulong line_i;           
        ulong nb_ext_chars;     
        struct UtExtCharLine * next;    
} UtExtCharLine;


/***************************************************************************/
typedef enum UtEolType {
        UT_EOL_UNSET=-1, 
        UT_EOL_CR,
        UT_EOL_LF,
        UT_EOL_CRLF,
        UT_EOL_LFCR,
        UT_EOL_MIX,             
        UT_EOL_BSN,             
        UT_EOL_NUL,             
//      UT_EOL_SPACE,
//      UT_EOL_TAB,
//      UT_EOL_NOCHANGE,        //!< Conversion only
        UT_EOL_NONE             //always the last
} UtEolType;

extern const char * UT_EOL_NAME [];

typedef short UtCharsetIndex;

/***************************************************************************/
typedef struct UtText {
        char * data;                                    
        ulong size;                                             

        UtEolType eol;                                  
        UtEolType eol_alt;                              
        UtCharsetIndex charset;                 

        ulong nb_lines;                                 
        ulong nb_lines_alt;                             
        ulong * distribution;                   
        UtExtCharLine * ext_char;               
        UtCharsetEval * evaluation;             

        UtTextFlags flags;                              
        UtPassFlags pass_flags;
        char skip_char;                                 


        float progress_done;                    
        int progress_todo;                              
        UtPassFlags current_pass;               
        
        void * user;                                    
} UtText;

#endif //_UT_TEXT_H_

---