/*************************************************************************
*									 *
*	 YAP Prolog 							 *
*									 *
*	Yap Prolog was developed at NCCUP - Universidade do Porto	 *
*									 *
* Copyright L.Damas, V.S.Costa and Universidade do Porto 1985-1997	 *
*									 *
**************************************************************************
*									 *
* File:		YapMirror.c						 *
* Last rev:	5/2/88							 *
* mods:									 *
* comments:	Term conversion C implemented support			 *
*									 *
*************************************************************************/
#ifndef YAP_TEXT_H
#define YAP_TEXT_H

#if SIZEOF_WCHAR_T == 2
#define CHARCODE_MAX 0xffff
#else
#define CHARCODE_MAX 0x10ffff
#endif

/*
 * This file defines main data-structure for text conversion and
 * mirroring
 */

#include "Yap.h"
#include "utf8proc.h"

inline static utf8proc_ssize_t get_utf8(utf8proc_uint8_t * ptr, utf8proc_int32_t *valp) { return utf8proc_iterate( ptr, -1, valp ); }

inline static utf8proc_ssize_t put_utf8(utf8proc_uint8_t * ptr, utf8proc_int32_t val) { return utf8proc_encode_char( val, ptr ); }

inline static  utf8proc_uint8_t *skip_utf8( utf8proc_uint8_t * pt, utf8proc_ssize_t n) {
  utf8proc_ssize_t i;
  utf8proc_int32_t b;
  for (i=0;i< n; i++) {
    utf8proc_ssize_t l = utf8proc_iterate( pt, -1, &b );
    if (b==0) return pt;
    pt += l;
  }
  return pt;
}

inline static utf8proc_ssize_t strlen_utf8(const utf8proc_uint8_t * pt) {
  utf8proc_ssize_t rc =0;
  utf8proc_int32_t b;
  while (true) {
    utf8proc_ssize_t l = utf8proc_iterate( pt, -1, &b );
    if (b==0) return rc;
    pt += l;
    rc += l;
  }
  return rc;
}

inline static utf8proc_ssize_t strlen_latin_utf8(const unsigned char * pt) {
  utf8proc_ssize_t rc =0;
  utf8proc_uint8_t b;
  while (true) {
    utf8proc_ssize_t l = utf8proc_encode_char( *pt, &b );
    if (b==0) return rc;
    pt++;
    rc += l;
  }
  return rc;
}

inline static utf8proc_ssize_t strnlen_latin_utf8(const unsigned char * pt, size_t max) {
  utf8proc_ssize_t rc =0;
  utf8proc_uint8_t b;
  while (true) {
    utf8proc_ssize_t l = utf8proc_encode_char( *pt, &b );
    if (b==0) return rc;
    pt++;
    rc += l;
    if (--max == 0) return rc; 
  }
  return rc;
}

inline static utf8proc_ssize_t strlen_ucs2_utf8(const wchar_t * pt) {
  utf8proc_ssize_t rc =0;
  utf8proc_uint8_t b;
  while (true) {
    utf8proc_ssize_t l =  utf8proc_encode_char( *pt, &b );
    if (b==0) return rc;
    pt ++;
    rc += l;
  }
  return rc;
}

inline static utf8proc_ssize_t strnlen_ucs2_utf8(const wchar_t * pt, size_t max) {
  utf8proc_ssize_t rc =0;
  utf8proc_uint8_t b;
  while (true) {
    utf8proc_ssize_t l =  utf8proc_encode_char( *pt, &b );
    if (b==0) return rc;
    pt ++;
    rc += l;
    if (--max == 0) return rc; 
  }
  return rc;
}

inline static int cmpn_utf8(const utf8proc_uint8_t * pt1, const utf8proc_uint8_t * pt2, utf8proc_ssize_t n) {
  utf8proc_ssize_t i;
  utf8proc_int32_t b;
  for (i=0;i< n; i++) {
    if (pt1[0] != pt2[0]) return pt1[0]- pt2[0];
    utf8proc_ssize_t l = utf8proc_iterate( pt1, -1, &b );
    if (l == 2) { if (pt1[1] != pt2[1]) return pt1[1]- pt2[1]; }
    else if (l == 3) { if (pt1[2] != pt2[2]) return pt1[2]- pt2[2]; }
    else if (l == 4) { if (pt1[3] != pt2[3]) return pt1[3]- pt2[3]; }
    pt1 += l;
    pt2 += l;
                                         
  }
  return 0;
}

const char *Yap_tokRep(TokEntry *tokptr);

// standard strings

typedef enum {
  YAP_STRING_STRING = 0x1, /// target is a string term
  YAP_STRING_CODES = 0x2, /// target is a list of integer codes
  YAP_STRING_ATOMS = 0x4, /// target is a list of kength-1 atom
  YAP_STRING_ATOMS_CODES = 0x6, /// targt is list of atoms or codes
  YAP_STRING_CHARS = 0x8,  /// target is a buffer, with byte-sized units
  YAP_STRING_WCHARS = 0x10, /// target is a buffer of wide chars
  YAP_STRING_ATOM = 0x20,   /// tarfet is an ayom
  YAP_STRING_INT = 0x40,  /// target is an integer term 
  YAP_STRING_FLOAT = 0x80,  /// target is a floar term
  YAP_STRING_BIG = 0x100,  /// target is an big num term
  YAP_STRING_DATUM = 0x200,   /// associated with previous 3, use actual object if type, not tern
  YAP_STRING_LENGTH = 0x400,  /// input: length is fixed; output: return integer with length
  YAP_STRING_NTH = 0x800,   ///  input: ignored; output: nth char
  YAP_STRING_TERM = 0x1000, // Generic term, if nothing else given
  YAP_STRING_DIFF = 0x2000,  // difference list
  YAP_STRING_NCHARS = 0x4000,  // size of input/result
  YAP_STRING_TRUNC = 0x8000,  // truncate on maximum size of input/result
  YAP_STRING_WQ =  0x10000,  // output with write_quote
  YAP_STRING_WC = 0x20000,  // output with write_canonical
  YAP_STRING_WITH_BUFFER = 0x40000,  // output on existing buffer
  YAP_STRING_MALLOC = 0x80000  // output on malloced buffer
} enum_seq_type_t;



typedef UInt seq_type_t;

#define YAP_TYPE_MASK 0x0FFF

typedef union {
  Float  f;
  Int  i;
  MP_INT *b;
  const char *c0;
  const wchar_t *w0;
  char *c;
  unsigned char *uc;
  wchar_t *w;
  Atom   a;
  size_t l;
  int d;
  Term   t;// depends on other flags
}
seq_val_t;

typedef struct text_cvt {
  seq_type_t type;
  seq_val_t val;
  Term      mod; // optional
  size_t     sz; // fixed sz, or -1
  Term      dif; // diff-list, usually TermNil
  size_t    max; // max_size
  encoding_t enc;
} seq_tv_t;

// string construction
#ifdef HR
static inline Term
init_tstring( USES_REGS1 ) {
  Term t = AbsAppl(HR);

  HR[0] = (CELL)FunctorString;
  return t;
}

static inline unsigned char *
buf_from_tstring( CELL *p ) {
  unsigned char *out = (unsigned char *)(p + 2);
  return out;
}

static inline void
close_tstring( unsigned char *p USES_REGS ) {
  CELL *szp = HR+1;
  HR = (CELL *)ALIGN_BY_TYPE( p ,CELL);
  *szp = (HR - szp)-1;
  *HR++ = EndSpecials;
}
#endif

// string type depends on current module
static inline seq_type_t
mod_to_type( Term mod USES_REGS )
{
  
  // see pl-incl.h
  unsigned int flags = Yap_GetModuleEntry(mod)->flags;
  if (flags & DBLQ_ATOM) {
    return YAP_STRING_ATOM;
  } else if (flags & DBLQ_STRING) {
    return YAP_STRING_STRING;
  } else if (flags &  DBLQ_CHARS) {
    return YAP_STRING_ATOMS;
  }
  return YAP_STRING_CODES;
}

// string type depends on current module
static inline seq_type_t
mod_to_bqtype( Term mod USES_REGS )
{
  
  // see pl-incl.h
  unsigned int flags = Yap_GetModuleEntry(mod)->flags;
  if (flags & BCKQ_ATOM) {
    return YAP_STRING_ATOM;
  } else if (flags & BCKQ_STRING) {
    return YAP_STRING_STRING;
  } else if (flags &  BCKQ_CHARS) {
    return YAP_STRING_ATOMS;
  }
  return YAP_STRING_CODES;
}

// the routines

extern  void *Yap_readText( void *buf, seq_tv_t *inp, encoding_t *enc, int *minimal, size_t *lengp USES_REGS);
extern int write_Text( void *inp, seq_tv_t *out, encoding_t enc, int minimal, size_t leng  USES_REGS);
extern int   Yap_CVT_Text( seq_tv_t *inp, seq_tv_t *out USES_REGS);
extern void *Yap_Concat_Text( int n,  seq_tv_t inp[], seq_tv_t *out USES_REGS);
extern void *Yap_Splice_Text( int n,  size_t cuts[], seq_tv_t *inp, encoding_t encv[], seq_tv_t outv[] USES_REGS);

// user friendly interface

static inline size_t
Yap_AtomicToLength(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_CODES|YAP_STRING_ATOMS|YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  out.type = YAP_STRING_LENGTH;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_AtomicToListOfAtoms(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  out.type = YAP_STRING_ATOMS;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_AtomicToListOfCodes(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  out.type = YAP_STRING_CODES;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Atom
Yap_AtomicToAtom(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  out.type = YAP_STRING_ATOM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.a;
}

static inline size_t
Yap_AtomToLength(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_ATOM;
  out.type = YAP_STRING_LENGTH;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return (size_t)(-1L);
  return out.val.l;
}

static inline Term
Yap_AtomToListOfAtoms(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_ATOM;
  out.type = YAP_STRING_ATOMS;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_AtomSWIToListOfAtoms(Term t0 USES_REGS)
{
  seq_tv_t inp, out;

  inp.val.t = t0;
  inp.type = YAP_STRING_ATOM|YAP_STRING_STRING|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_ATOMS_CODES|YAP_STRING_TERM;
  out.type = YAP_STRING_ATOMS;

  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}


static inline Term
Yap_AtomToListOfCodes(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_ATOM;
  out.type = YAP_STRING_CODES;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_AtomToNumber(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_ATOM;
  out.type = YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_AtomToString(Term t0 USES_REGS)
{
  seq_tv_t inp, out;

  inp.val.t = t0;
  inp.type = YAP_STRING_ATOM;
  out.type = YAP_STRING_STRING;

  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_AtomSWIToString(Term t0 USES_REGS)
{
  seq_tv_t inp, out;

  inp.val.t = t0;
  inp.type = YAP_STRING_ATOM|YAP_STRING_STRING|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_ATOMS_CODES|YAP_STRING_TERM;
  out.type = YAP_STRING_STRING;

  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_AtomicToString(Term t0 USES_REGS)
{
  seq_tv_t inp, out;

  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  out.type = YAP_STRING_STRING;

  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_AtomicToTDQ(Term t0, Term mod USES_REGS)
{
  seq_tv_t inp, out;
  
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  out.type = mod_to_type(mod PASS_REGS);
  
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  if (out.type == YAP_STRING_ATOM)
    return MkAtomTerm( out.val.a);
  return out.val.t;
}

static inline Term
Yap_AtomicToTBQ(Term t0, Term mod USES_REGS)
{
  seq_tv_t inp, out;
  
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  out.type = mod_to_bqtype(mod PASS_REGS);
  
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  if (out.type == YAP_STRING_ATOM)
    return MkAtomTerm( out.val.a);
  return out.val.t;
}

static inline Atom
Yap_CharsToAtom( const char *s, encoding_t enc  USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.c0 = s;
  inp.sz = 0;
  inp.enc = enc;
  inp.type = YAP_STRING_CHARS;
  out.type = YAP_STRING_ATOM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.a;
}

static inline Term
Yap_CharsToListOfAtoms( const char *s, encoding_t enc USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.c0 = s;
  inp.sz = 0;
  inp.enc = enc;
  inp.type = YAP_STRING_CHARS;
  out.type = YAP_STRING_ATOMS;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_CharsToListOfCodes( const char *s, encoding_t enc USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.c0 = s;
  inp.sz = 0;
  inp.enc = enc;
  inp.type = YAP_STRING_CHARS;
  out.type = YAP_STRING_CODES;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_UTF8ToListOfCodes( const char *s USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.c0 = s;
  inp.sz = 0;
  inp.type = YAP_STRING_CHARS;
  inp.enc = ENC_ISO_UTF8;
  out.type = YAP_STRING_CODES;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_CharsToDiffListOfCodes( const char *s, Term tail, encoding_t enc USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.c0 = s;
  inp.sz = 0;
  inp.enc = enc;
  inp.type = YAP_STRING_CHARS;
  out.type = YAP_STRING_DIFF|YAP_STRING_CODES;
  out.dif = tail;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_UTF8ToDiffListOfCodes( const char *s, Term tail USES_REGS )
{
  seq_tv_t inp, out;
  
  inp.val.c0 = s;
  inp.sz = 0;
  inp.type = YAP_STRING_CHARS;
  inp.enc = ENC_ISO_UTF8;
  out.type = YAP_STRING_DIFF|YAP_STRING_CODES;
  out.dif = tail;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_WCharsToDiffListOfCodes( const wchar_t *s, Term tail USES_REGS )
{
  seq_tv_t inp, out;
  
  inp.val.w0 = s;
  inp.sz = 0;
  inp.type = YAP_STRING_WCHARS;
  out.type = YAP_STRING_DIFF|YAP_STRING_CODES;
  out.dif = tail;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_CharsToString( const char *s, encoding_t enc USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.c0 = s;
  inp.sz = 0;
  inp.enc = enc;
  inp.type = YAP_STRING_CHARS;
  out.type = YAP_STRING_STRING;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline char *
Yap_AtomToUTF8Text( Atom at, const char *s USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.a = at;
  inp.sz = 0;
  inp.type = YAP_STRING_ATOM;
  out.type = YAP_STRING_CHARS;
  out.enc = ENC_ISO_UTF8;
  if (s) {
    out.val.c0 = s;
    out.type |= YAP_STRING_WITH_BUFFER;
  } else {
    out.val.c = NULL;
  }
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.c;
}

static inline Term
Yap_CharsToTDQ( const char *s, Term mod, encoding_t enc USES_REGS )
{
  seq_tv_t inp, out;
  
  inp.val.c0 = s;
  inp.sz = 0;
  inp.type = YAP_STRING_CHARS;
  inp.mod = mod;
  inp.enc = enc;
  out.type = mod_to_type(mod PASS_REGS);
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  if (out.type == YAP_STRING_ATOM)
    return MkAtomTerm( out.val.a );
  return out.val.t;
}

static inline Term
Yap_CharsToTBQ( const char *s, Term mod, encoding_t enc USES_REGS )
{
  seq_tv_t inp, out;
  
  inp.val.c0 = s;
  inp.sz = 0;
  inp.type = YAP_STRING_CHARS;
  inp.mod = mod;
  inp.enc = enc;
  out.type = mod_to_bqtype(mod PASS_REGS);
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  if (out.type == YAP_STRING_ATOM)
    return MkAtomTerm( out.val.a );
  return out.val.t;
}

static inline Atom
Yap_ListOfAtomsToAtom(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_ATOMS;
  out.type = YAP_STRING_ATOM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return (Atom)NULL;
  return out.val.a;
}

static inline Term
Yap_ListOfAtomsToNumber(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_ATOMS;
  out.type = YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_ListOfAtomsToString(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_ATOMS;
  out.type = YAP_STRING_STRING;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Atom
Yap_ListOfCodesToAtom(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_CODES;
  out.type = YAP_STRING_ATOM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return (Atom)NULL;
  return out.val.a;
}

static inline Term
Yap_ListOfCodesToNumber(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_CODES;
  out.type = YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_ListOfCodesToString(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_CODES;
  out.type = YAP_STRING_STRING;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Atom
Yap_ListToAtom(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOMS_CODES|YAP_STRING_TERM|YAP_STRING_ATOM;
  out.type = YAP_STRING_ATOM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.a;
}

static inline Term
Yap_ListToAtomic(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOMS_CODES|YAP_STRING_TERM;
  out.type = YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_ListToNumber(Term t0 USES_REGS)
{
  seq_tv_t inp, out;

  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOMS_CODES|YAP_STRING_TERM;
  out.type = YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;

  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}


static inline Term
Yap_ListToString(Term t0 USES_REGS)
{
  seq_tv_t inp, out;

  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOMS_CODES|YAP_STRING_TERM;
  out.type = YAP_STRING_STRING;

  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}


static inline Term
Yap_ListSWIToString(Term t0 USES_REGS)
{
  seq_tv_t inp, out;

  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOM|YAP_STRING_ATOMS_CODES|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  out.type = YAP_STRING_STRING;

  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}


static inline Term
YapListToTDQ(Term t0, Term mod USES_REGS)
{
  seq_tv_t inp, out;
  
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOMS_CODES|YAP_STRING_TERM;
  out.type = mod_to_type(mod PASS_REGS);
  
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  if (out.type == YAP_STRING_ATOM) {
    return MkAtomTerm( out.val.a);
  }
  return out.val.t;
}

static inline Term
YapListToTBQ(Term t0, Term mod USES_REGS)
{
  seq_tv_t inp, out;
  
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOMS_CODES|YAP_STRING_TERM;
  out.type = mod_to_bqtype(mod PASS_REGS);
  
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  if (out.type == YAP_STRING_ATOM) {
    return MkAtomTerm( out.val.a);
  }
  return out.val.t;
}

static inline Atom
Yap_NCharsToAtom( const char *s, size_t len, encoding_t enc USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.c0 = s;
  inp.sz = len;
  inp.type = YAP_STRING_CHARS|YAP_STRING_NCHARS;
  inp.enc = enc;
  out.type = YAP_STRING_ATOM;
  out.max = len;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.a;
}

static inline Term
Yap_CharsToDiffListOfAtoms( const char *s, encoding_t enc, Term tail USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.c0 = s;
  inp.type = YAP_STRING_CHARS;
  inp.enc = enc;
  out.type = YAP_STRING_ATOMS|YAP_STRING_DIFF;
  out.dif = tail;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}


static inline Term
Yap_NCharsToListOfCodes( const char *s, size_t len, encoding_t enc USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.c0 = s;
  inp.sz = len;
  inp.type = YAP_STRING_CHARS|YAP_STRING_NCHARS;
  inp.enc = enc;
  out.type = YAP_STRING_CODES;
  out.max = len;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_NCharsToString( const char *s, size_t len, encoding_t enc USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.c0 = s;
  inp.sz = len;
  inp.enc = enc;
  inp.type = YAP_STRING_CHARS|YAP_STRING_NCHARS;
  out.type = YAP_STRING_STRING;
  out.max = len;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_NCharsToTDQ( const char *s, size_t len, encoding_t enc, Term mod USES_REGS )
{
  seq_tv_t inp, out;
  
  inp.val.c0 = s;
  inp.type = YAP_STRING_CHARS|YAP_STRING_NCHARS;
  inp.sz = len;
  inp.enc = enc;
  inp.mod = mod;
  out.type = mod_to_type(mod PASS_REGS);
  out.max = len;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  if (out.type == YAP_STRING_ATOM)
    return MkAtomTerm( out.val.a );
  return out.val.t;
}

static inline Term
Yap_NCharsToTBQ( const char *s, size_t len, encoding_t enc,  Term mod USES_REGS )
{
  seq_tv_t inp, out;
  
  inp.val.c0 = s;
  inp.type = YAP_STRING_CHARS|YAP_STRING_NCHARS;
  inp.sz = len;
  inp.enc = enc;
  inp.mod = mod;
  out.type = mod_to_bqtype(mod PASS_REGS);
  out.max = len;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  if (out.type == YAP_STRING_ATOM)
    return MkAtomTerm( out.val.a );
  return out.val.t;
}

static inline Atom
Yap_NumberToAtom(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  out.type = YAP_STRING_ATOM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.a;
}

static inline Term
Yap_NumberToListOfAtoms(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  out.type = YAP_STRING_ATOMS;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_NumberToListOfCodes(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  out.type = YAP_STRING_CODES;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_NumberToString(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  out.type = YAP_STRING_STRING;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Atom
Yap_NWCharsToAtom( const wchar_t *s, size_t len USES_REGS )
{
    seq_tv_t inp, out;

    inp.val.w0 = s;
    inp.sz = len;
    inp.type = YAP_STRING_WCHARS|YAP_STRING_NCHARS;
    out.type = YAP_STRING_ATOM;
    out.max = len;
    if (!Yap_CVT_Text(&inp, &out PASS_REGS))
        return 0L;
    return out.val.a;
}

static inline Term
Yap_NWCharsToListOfAtoms( const wchar_t *s, size_t len USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.w0 = s;
  inp.sz = len;
  inp.type = YAP_STRING_WCHARS|YAP_STRING_NCHARS;
  out.type = YAP_STRING_ATOMS;
  out.max = len;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_NWCharsToListOfCodes( const wchar_t *s, size_t len USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.w0 = s;
  inp.sz = len;
  inp.type = YAP_STRING_WCHARS|YAP_STRING_NCHARS;
  out.type = YAP_STRING_CODES;
  out.max = len;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_NWCharsToString( const wchar_t *s, size_t len USES_REGS )
{
  seq_tv_t inp, out;

  inp.val.w0 = s;
  inp.sz = len;
  inp.type = YAP_STRING_WCHARS|YAP_STRING_NCHARS;
  out.type = YAP_STRING_STRING;
  out.max = len;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Atom
Yap_StringToAtom(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.sz = 0;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING;
  out.type = YAP_STRING_ATOM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.a;
}

static inline Atom
Yap_StringSWIToAtom(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.sz = 0;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_ATOMS_CODES|YAP_STRING_TERM;
  out.type = YAP_STRING_ATOM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.a;
}

static inline size_t
Yap_StringToAtomic(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.sz = 0;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING;
  out.type = YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline size_t
Yap_StringToLength(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.sz = 0;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING;
  out.type = YAP_STRING_LENGTH;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return (size_t)(-1L);
  return out.val.l;
}

static inline size_t
Yap_StringToListOfAtoms(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.sz = 0;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING;
  out.type = YAP_STRING_ATOMS;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline size_t
Yap_StringSWIToListOfAtoms(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.sz = 0;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_ATOMS_CODES|YAP_STRING_TERM;
  out.type = YAP_STRING_ATOMS;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline size_t
Yap_StringToListOfCodes(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.sz = 0;
  inp.type = YAP_STRING_STRING;
  out.type = YAP_STRING_CODES;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline size_t
Yap_StringSWIToListOfCodes(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.type = YAP_STRING_STRING|YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_ATOMS_CODES|YAP_STRING_TERM;
  out.type = YAP_STRING_CODES;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_StringToNumber(Term t0 USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.t = t0;
  inp.sz = 0;
  inp.type = YAP_STRING_STRING;
  out.type = YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_WCharsToListOfCodes(const wchar_t *s USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.w0 = s;
  inp.sz = 0;
  inp.type = YAP_STRING_WCHARS;
  out.type = YAP_STRING_CODES;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Term
Yap_WCharsToTDQ( wchar_t *s, Term mod USES_REGS )
{
  seq_tv_t inp, out;
  
  inp.val.w0 = s;
  inp.type = YAP_STRING_WCHARS;
  inp.sz = 0;
  inp.mod = mod;
  out.type = mod_to_type(mod PASS_REGS);
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  if (out.type == YAP_STRING_ATOM)
    return MkAtomTerm( out.val.a);
  return out.val.t;
}

static inline Term
Yap_WCharsToTBQ( wchar_t *s, Term mod USES_REGS )
{
  seq_tv_t inp, out;
  
  inp.val.w = s;
  inp.type = YAP_STRING_WCHARS;
  inp.sz = 0;
  inp.mod = mod;
  out.type = mod_to_bqtype(mod PASS_REGS);
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  if (out.type == YAP_STRING_ATOM)
    return MkAtomTerm( out.val.a);
  return out.val.t;
}

static inline Term
Yap_WCharsToString(const wchar_t *s USES_REGS)
{
  seq_tv_t inp, out;
  inp.val.w0 = s;
  inp.sz = 0;
  inp.type = YAP_STRING_WCHARS;
  out.type = YAP_STRING_STRING;
  if (!Yap_CVT_Text(&inp, &out PASS_REGS))
    return 0L;
  return out.val.t;
}

static inline Atom
Yap_ConcatAtoms(Term t1, Term t2 USES_REGS)
{
  seq_tv_t inpv[2], out;
  inpv[0].val.t = t1;
  inpv[0].type = YAP_STRING_ATOM;
  inpv[0].sz = 0;
  inpv[1].val.t = t2;
  inpv[1].type = YAP_STRING_ATOM;
  inpv[1].sz = 0;
  out.type = YAP_STRING_ATOM;
  if (!Yap_Concat_Text(2, inpv, &out PASS_REGS))
    return (Atom)NULL;
  return out.val.a;
}

static inline Atom
Yap_ConcatAtomics(Term t1, Term t2 USES_REGS)
{
  seq_tv_t inpv[2], out;
  inpv[0].val.t = t1;
  inpv[0].type = YAP_STRING_STRING|YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  inpv[0].sz = 0;
  inpv[1].val.t = t2;
  inpv[1].type = YAP_STRING_STRING|YAP_STRING_ATOM|YAP_STRING_INT|YAP_STRING_FLOAT|YAP_STRING_BIG|YAP_STRING_TERM;
  inpv[1].sz = 0;
  out.type = YAP_STRING_ATOM;
  if (!Yap_Concat_Text(2, inpv, &out PASS_REGS))
    return (Atom)NULL;
  return out.val.a;
}

static inline Term
Yap_ConcatStrings(Term t1, Term t2 USES_REGS)
{
  seq_tv_t inpv[2], out;
  inpv[0].val.t = t1;
  inpv[0].type = YAP_STRING_STRING;
  inpv[0].sz = 0;
  inpv[1].val.t = t2;
  inpv[1].type = YAP_STRING_STRING;
  inpv[1].sz = 0;
  out.type = YAP_STRING_STRING;
  if (!Yap_Concat_Text(2, inpv, &out PASS_REGS))
    return 0L;
  return out.val.t;
}


static inline Atom
Yap_SpliceAtom(Term t1, Atom ats[], size_t cut, size_t max USES_REGS)
{
  seq_tv_t outv[2], inp;
  size_t cuts[2];
  cuts[0] = cut;
  cuts[1] = max;
  inp.type = YAP_STRING_ATOM;
  inp.val.t = t1;
  inp.sz = 0;
  outv[0].type = YAP_STRING_ATOM;
  outv[0].sz = 0;
  outv[1].type = YAP_STRING_ATOM;
  outv[1].sz = 0;
  if (!Yap_Splice_Text(2, cuts, &inp, (encoding_t *)NULL, outv PASS_REGS))
    return (Atom)NULL;
  ats[0] = outv[0].val.a;
  ats[1] = outv[1].val.a;
  return ats[0];
}

static inline Atom
Yap_SubtractHeadAtom(Term t1, Term th USES_REGS)
{
  seq_tv_t outv[2], inp;
  inp.type = YAP_STRING_ATOM;
  inp.val.t = t1;
  inp.sz = 0;
  outv[0].type = YAP_STRING_ATOM;
  outv[0].val.t = th;
  outv[0].sz = 0;
  outv[1].type = YAP_STRING_ATOM;
  outv[1].val.t = 0;
  outv[1].sz = 0;
  if (!Yap_Splice_Text(2, (size_t *)NULL, &inp, (encoding_t *)NULL, outv PASS_REGS))
    return (Atom)NULL;
  return outv[1].val.a;
}


static inline Atom
Yap_SubtractTailAtom(Term t1, Term th USES_REGS)
{
  seq_tv_t outv[2], inp;
  inp.type = YAP_STRING_ATOM;
  inp.val.t = t1;
  inp.sz = 0;
  outv[0].type = YAP_STRING_ATOM;
  outv[0].val.t = 0;
  outv[0].sz = 0;
  outv[1].type = YAP_STRING_ATOM;
  outv[1].val.t = th;
  if (!Yap_Splice_Text(2, (size_t *)NULL, &inp, (encoding_t *)NULL, outv PASS_REGS))
    return (Atom)NULL;
  return outv[0].val.a;
}

static inline Term
Yap_SpliceString(Term t1, Term ts[], size_t cut, size_t max USES_REGS)
{
  seq_tv_t outv[2], inp;
  size_t cuts[2];
  inp.type = YAP_STRING_STRING;
  inp.val.t = t1;
  inp.sz = 0;
  outv[0].type = YAP_STRING_STRING;
  outv[1].type = YAP_STRING_STRING;
  outv[1].sz = 0;
  cuts[0] = cut;
  cuts[1] = max;
  if (!Yap_Splice_Text(2, cuts, &inp, (encoding_t *)NULL, outv PASS_REGS))
    return 0L;
  ts[0] = outv[0].val.t;
  ts[1] = outv[1].val.t;
  return ts[0];
}

static inline Term
Yap_SubtractHeadString(Term t1, Term th USES_REGS)
{
  seq_tv_t outv[2], inp;
  inp.type = YAP_STRING_STRING;
  inp.val.t = t1;
  inp.sz = 0;
  outv[0].type = YAP_STRING_STRING;
  outv[0].val.t = th;
  outv[0].sz = 0;
  outv[1].type = YAP_STRING_STRING;
  outv[1].val.t = 0;
  outv[1].sz = 0;
  if (!Yap_Splice_Text(2, (size_t *)NULL, &inp, (encoding_t *)NULL, outv PASS_REGS))
    return 0L;
  return outv[1].val.t;
}

static inline Term
Yap_SubtractTailString(Term t1, Term th USES_REGS)
{
  seq_tv_t outv[2], inp;
  inp.type = YAP_STRING_STRING;
  inp.val.t = t1;
  inp.sz = 0;
  outv[0].type = YAP_STRING_STRING;
  outv[0].val.t = 0;
  outv[0].sz = 0;
  outv[1].type = YAP_STRING_STRING;
  outv[1].val.t = th;
  if (!Yap_Splice_Text(2, (size_t *)NULL, &inp, (encoding_t *)NULL, outv PASS_REGS))
    return 0L;
  return outv[0].val.t;
}

#endif // ≈YAP_TEXT_H