Orcus
Public Types | Public Member Functions | List of all members
orcus::spreadsheet::import_shared_strings Class Reference

#include <shared_strings.hpp>

Inheritance diagram for orcus::spreadsheet::import_shared_strings:
orcus::spreadsheet::iface::import_shared_strings

Public Types

typedef std::unordered_map< size_t, format_runs_t * > format_runs_map_type
 

Public Member Functions

 import_shared_strings (orcus::string_pool &sp, ixion::model_context &cxt, styles &styles)
 
virtual size_t append (const char *s, size_t n)
 
virtual size_t add (const char *s, size_t n)
 
virtual void set_segment_font (size_t font_index)
 
virtual void set_segment_bold (bool b)
 
virtual void set_segment_italic (bool b)
 
virtual void set_segment_font_name (const char *s, size_t n)
 
virtual void set_segment_font_size (double point)
 
virtual void set_segment_font_color (color_elem_t alpha, color_elem_t red, color_elem_t green, color_elem_t blue)
 
virtual void append_segment (const char *s, size_t n)
 
virtual size_t commit_segments ()
 
const format_runs_t * get_format_runs (size_t index) const
 
const std::string * get_string (size_t index) const
 
void dump () const
 

Detailed Description

This class handles global pool of string instances.

Member Function Documentation

◆ add()

virtual size_t orcus::spreadsheet::import_shared_strings::add ( const char *  s,
size_t  n 
)
virtual

Similar to the append method, it adds new string to the string pool; however, this method checks if the string being added is already in the pool before each insertion, to avoid duplicated strings.

Parameters
spointer to the first character of the string array. The string array doesn't necessary have to be null-terminated.
nlength of the string.
Returns
ID of the string just inserted.

Implements orcus::spreadsheet::iface::import_shared_strings.

◆ append()

virtual size_t orcus::spreadsheet::import_shared_strings::append ( const char *  s,
size_t  n 
)
virtual

Append new string to the string list. Order of insertion is important since that determines the numerical ID values of inserted strings. Note that this method assumes that the caller knows the string being appended is not yet in the pool.

Parameters
spointer to the first character of the string array. The string array doesn't necessary have to be null-terminated.
nlength of the string.
Returns
ID of the string just inserted.

Implements orcus::spreadsheet::iface::import_shared_strings.

◆ append_segment()

virtual void orcus::spreadsheet::import_shared_strings::append_segment ( const char *  s,
size_t  n 
)
virtual

Append a string segment with the current format attributes to the formatted string buffer.

Parameters
spointer to the first character of the string array. The string array doesn't necessary have to be null-terminated.
nlength of the string.

Implements orcus::spreadsheet::iface::import_shared_strings.

◆ commit_segments()

virtual size_t orcus::spreadsheet::import_shared_strings::commit_segments ( )
virtual

Store the formatted string in the current buffer to the shared strings store. The implementation may choose to unconditionally append the string to the store, or choose to look for an existing indentical formatted string to reuse and discard the new one if one exists.

Returns
ID of the string just inserted, or the ID of an existing string with identical formatting attributes.

Implements orcus::spreadsheet::iface::import_shared_strings.

◆ set_segment_bold()

virtual void orcus::spreadsheet::import_shared_strings::set_segment_bold ( bool  b)
virtual

Set whether or not to make the font bold to the current format attributes.

Parameters
btrue if it's bold, false otherwise.

Implements orcus::spreadsheet::iface::import_shared_strings.

◆ set_segment_font()

virtual void orcus::spreadsheet::import_shared_strings::set_segment_font ( size_t  font_index)
virtual

Set the index of a font to apply to the current format attributes.

Parameters
font_indexpositive integer representing the font to use.

Implements orcus::spreadsheet::iface::import_shared_strings.

◆ set_segment_font_color()

virtual void orcus::spreadsheet::import_shared_strings::set_segment_font_color ( color_elem_t  alpha,
color_elem_t  red,
color_elem_t  green,
color_elem_t  blue 
)
virtual

Set the color of a font in ARGB to the current format attributes.

Parameters
alphaalpha component value (0-255).
redred component value (0-255).
greengreen component value (0-255).
blueblue component value (0-255).

Implements orcus::spreadsheet::iface::import_shared_strings.

◆ set_segment_font_name()

virtual void orcus::spreadsheet::import_shared_strings::set_segment_font_name ( const char *  s,
size_t  n 
)
virtual

Set the name of a font to the current format attributes.

Parameters
spointer to the first character of a char array that stores the font name.
nsize of the char array that stores the font name.

Implements orcus::spreadsheet::iface::import_shared_strings.

◆ set_segment_font_size()

virtual void orcus::spreadsheet::import_shared_strings::set_segment_font_size ( double  point)
virtual

Set a font size to the current format attributes.

Parameters
pointfont size in points.

Implements orcus::spreadsheet::iface::import_shared_strings.

◆ set_segment_italic()

virtual void orcus::spreadsheet::import_shared_strings::set_segment_italic ( bool  b)
virtual

Set whether or not to set the font italic font to the current format attributes.

Parameters
btrue if it's italic, false otherwise.

Implements orcus::spreadsheet::iface::import_shared_strings.