typedef struct M_RopeRec_*     M_Rope;

a handle to a M_RopeRec structure. Ropes are simple dynamic strings they are easy to use for appends, prepends, inserts, etc..

  typedef struct M_RopeRec_
  {
    M_String  str;
    M_Size    len;

  } M_RopeRec;

this structure holds the public fields of a M_Rope object.

  MLIB_API(M_Rope)      m_rope_new( M_Memory   memory,
                                    M_CString  init,
                                    M_Bool     push );

create a new rope.

new rope handle

m_err_memory_alloc

  MLIB_API(M_Rope)      m_rope_new_c( M_Memory      memory,
                                      const M_Char  init,
                                      M_Bool        push );

create a new single-char rope.

new rope handle

m_err_memory_alloc

  MLIB_API(M_Rope)      m_rope_new_bound( M_Memory   memory,
                                          M_CString  init,
                                          M_Size     length,
                                          M_Bool     push );

create a new rope from a bounded string.

new rope handle

m_err_memory_alloc

  MLIB_API(void)        m_rope_destroy( M_Rope  rope );

destroy/release a given rope and its character string

  MLIB_API(M_String)    m_rope_destroy_keep( M_Rope  rope );

destroy/release a given rope, but keep its character string aliv

character string. it must be freed by the called through M_FREE or m_mem_free

  MLIB_API(void)        m_rope_append( M_Rope     target,
                                       M_CString  source );

append a given C string to a given rope

m_err_memory_alloc

  MLIB_API(void)        m_rope_append_bound( M_Rope     target,
                                             M_CString  source,
                                             M_Size     src_len );

append a given bounded string to a given rope

m_err_memory_alloc

  MLIB_API(void)        m_rope_append_c( M_Rope  target,
                                         M_Char  c );

append a given character to a given rope

m_err_memory_alloc

  MLIB_API(void)        m_rope_prepend( M_Rope     target,
                                        M_CString  source );

prepend a given C string to a rope

m_err_memory_alloc

  MLIB_API(void)        m_rope_prepend_bound( M_Rope     target,
                                              M_CString  source,
                                              M_Size     src_len );

prepend a given bounded string to a rope

m_err_memory_alloc

  MLIB_API(void)        m_rope_prepend_c( M_Rope  target,
                                          M_Char  c );

prepend a given character to a rope

m_err_memory_alloc

  MLIB_API(void)        m_rope_insert( M_Rope     target,
                                       M_Int      pos,
                                       M_CString  source );

insert a given C string within a rope

m_err_memory_alloc

  MLIB_API(void)        m_rope_insert_bound( M_Rope     target,
                                             M_Int      pos,
                                             M_CString  source,
                                             M_Size     src_len );

insert a given bounded string within a rope

m_err_memory_alloc

  MLIB_API(void)        m_rope_insert_c( M_Rope  target,
                                         M_Int   pos,
                                         M_Char  c );

insert a given character within a rope

m_err_memory_alloc

  MLIB_API(void)        m_rope_remove( M_Rope   target,
                                       M_Int    start,
                                       M_Int    len );

remove some bytes from a rope

m_err_memory_alloc

  MLIB_API(void)        m_rope_crop( M_Rope  target,
                                     M_Int   start,
                                     M_Int   len );

crop a given rope to only a few characters

m_err_memory_alloc

  MLIB_API(M_Int)       m_rope_compare( const M_Rope  rope1,
                                        const M_Rope  rope2 );

compare the content of two rope objects. this function is really useful as a generic comparison function for containers. Otherwise, you'd better directly use m_string_compare on the rope strings..

-1, 0 or 1, depending on the content of the ropes

  MLIB_API(M_Size)      m_rope_hash( const M_Rope  rope );

compute the hash from the content of a rope. this function is to be used as a generic hash for containers. Otherwise, you'd better use m_string_hash directly on the rope string

hash value

  MLIB_API(M_Rope)      m_rope_copy( const M_Rope  rope,
                                     M_Bool        push );

copy a given rope to another one

handle to new rope

  MLIB_API(void)        m_rope_push( M_Rope  rope );

push a given rope on top of the cleanup stack

  MLIB_API(void)        m_rope_pop( M_Rope  rope,
                                    M_Bool  keep_it );

pop a given rope from the top of the cleanup stack