extensions.h

Go to the documentation of this file.

/*
 * $Id: extensions.h 13831 2007-06-16 01:22:39Z cbiere $
 *
 * Copyright (c) 2002-2003, Raphael Manfredi
 *
 *----------------------------------------------------------------------
 * This file is part of gtk-gnutella.
 *
 *  gtk-gnutella 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.
 *
 *  gtk-gnutella 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with gtk-gnutella; if not, write to the Free Software
 *  Foundation, Inc.:
 *      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *----------------------------------------------------------------------
 */

#ifndef _core_extensions_h_
#define _core_extensions_h_

#include "common.h"

typedef enum ext_type {
    EXT_UNKNOWN = 0,    
    EXT_XML,            
    EXT_HUGE,           
    EXT_GGEP,           
    EXT_NONE,           
    EXT_TYPE_COUNT
} ext_type_t;

typedef enum ext_token {
    EXT_T_UNKNOWN = 0,      
    EXT_T_URN_BITPRINT,     
    EXT_T_URN_SHA1,         
    EXT_T_URN_EMPTY,        
    EXT_T_URN_BAD,          
    EXT_T_XML,              
    EXT_T_UNKNOWN_GGEP,     
    EXT_T_OVERHEAD,         
    EXT_T_GGEP_LIME_XML,    
    /* sort below */
    EXT_T_GGEP_A,           
    EXT_T_GGEP_ALT,         
    EXT_T_GGEP_ALT_TLS,     
    EXT_T_GGEP_BH,          
    EXT_T_GGEP_C,           
    EXT_T_GGEP_CT,          
    EXT_T_GGEP_DU,          
    EXT_T_GGEP_F,           
    EXT_T_GGEP_FW,          
    EXT_T_GGEP_GGEP,        
    EXT_T_GGEP_GTKG_IPV6,   
    EXT_T_GGEP_GTKG_TLS,    
    /* watch out, below is off-order */
    EXT_T_GGEP_GTKGV1,      
    EXT_T_GGEP_GUE,         
    EXT_T_GGEP_H,           
    EXT_T_GGEP_HNAME,       
    EXT_T_GGEP_IP,          
    EXT_T_GGEP_IPP,         
    EXT_T_GGEP_IPP_TLS,     
    EXT_T_GGEP_LF,          
    EXT_T_GGEP_LOC,         
    EXT_T_GGEP_NP,          
    EXT_T_GGEP_P,           
    EXT_T_GGEP_PATH,        
    EXT_T_GGEP_PHC,         
    EXT_T_GGEP_PUSH,        
    EXT_T_GGEP_PUSH_TLS,    
    EXT_T_GGEP_Q,           
    EXT_T_GGEP_SCP,         
    EXT_T_GGEP_SO,          
    EXT_T_GGEP_T,           
    EXT_T_GGEP_TLS,         
    EXT_T_GGEP_UA,          
    EXT_T_GGEP_UDPHC,       
    EXT_T_GGEP_UP,          
    EXT_T_GGEP_V,           
    EXT_T_GGEP_VC,          
    EXT_T_GGEP_VMSG,        
    EXT_T_GGEP_u,           
    EXT_T_TOKEN_COUNT
} ext_token_t;

#define GGEP_NAME(x) ext_ggep_name(EXT_T_GGEP_ ## x)
#define GGEP_GTKG_NAME(x) ext_ggep_name(EXT_T_GGEP_GTKG_ ## x)

typedef struct extvec {
    const gchar *ext_name;  
    ext_token_t ext_token;  
    ext_type_t ext_type;    
    gpointer opaque;        
} extvec_t;

#define MAX_EXTVEC      32  
/*
 * Public interface.
 */

void ext_init(void);
void ext_close(void);

void ext_prepare(extvec_t *exv, gint exvcnt);
gint ext_parse(const gchar *buf, gint len, extvec_t *exv, gint exvcnt);
void ext_reset(extvec_t *exv, gint exvcnt);

gboolean ext_is_printable(const extvec_t *e);
gboolean ext_is_ascii(const extvec_t *e);
gboolean ext_has_ascii_word(const extvec_t *e);

void ext_dump(FILE *fd, const extvec_t *extvec, gint extcnt,
    const gchar *prefix, const gchar *postfix, gboolean payload);

gconstpointer ext_payload(const extvec_t *e);
guint16 ext_paylen(const extvec_t *e);
const gchar *ext_base(const extvec_t *e);
guint16 ext_headlen(const extvec_t *e);
guint16 ext_len(const extvec_t *e);
const gchar *ext_ggep_id_str(const extvec_t *e);
const gchar *ext_ggep_name(ext_token_t id);

#endif  /* _core_extensions_h_ */

/* vi: set ts=4 sw=4 cindent: */

---