pwiz::util Namespace Reference

Namespaces
namespace	Base64
	Base-64 binary->text encoding (maps 3 bytes <-> 4 chars)
namespace	env

Classes
class	CharIndexedVectorIterator
	an iterator for CharIndexedVector More...
class	CharIndexedVectorConstIterator
	a const_iterator for CharIndexedVector More...
struct	CharIndexedVector
	a wrapper for boost::array that is indexable by character; supports indexes 0-127 More...
class	ClickwrapPrompter
	a barrier to force end users to agree/disagree to a prompt before continuing More...
class	COMInitializer
	Singleton used to initialize and uninitialize COM once per thread. More...
class	usage_exception
class	user_error
class	Image
	wrapper class for using 'gd' graphics library More...
class	IntegerSet
	a virtual container of integers, accessible via an iterator interface, stored as union of intervals More...
class	IterationListener
	interface to be implemented by clients who want progress callbacks More...
class	IterationListenerRegistry
	handles registration of IterationListeners and broadcast of update messages More...
class	mru_list
struct	once_flag_proxy
class	random_access_compressed_ifstream
class	SHA1SymmetricFilter
	model of boost::iostreams::SymmetricFilter More...
class	SHA1Filter
	model of boost::iostreams::Filter More...
class	SHA1_ostream
	ostream filter for calculating a SHA-1 hash of data on the fly More...
class	SHA1Calculator
class	shared_map
	copy semantics of shared_ptr<map<K,V> > with a std::map interface More...
class	Timer
struct	TestPathPredicate
	test implementations derive from this to define which paths should be tested More...
class	virtual_map
	a wrapper for std::map that will behave properly with polymorphism More...

Typedefs
typedef boost::shared_ptr < IterationListener >	IterationListenerPtr
typedef boost::iostreams::stream_offset	random_access_compressed_ifstream_off_t

Enumerations
enum	ByteSizeAbbreviation { ByteSizeAbbreviation_IEC, ByteSizeAbbreviation_JEDEC, ByteSizeAbbreviation_SI }

Functions
template<typename float_type >
bool	almost_equal (float_type a, float_type b, int multiplier=1)
std::string	ToStdString (System::String^source)
System::String	ToSystemString (const std::string &source)
template<typename managed_value_type , typename native_value_type >
void	ToStdVector (cli::array< managed_value_type >^managedArray, std::vector< native_value_type > &stdVector)
template<typename managed_value_type , typename native_value_type >
void	ToAutomationVector (cli::array< managed_value_type >^managedArray, automation_vector< native_value_type > &automationArray)
	wraps a managed array in an automation_vector to enable direct access from unmanaged code
std::string	format_date_time (const std::string &format, const bpt::ptime &t)
	formats a boost ptime according to a custom format string
std::string	format_date_time (const std::string &format, const blt::local_date_time &t)
	formats a boost local_date_time according to a custom format string
std::string	format_date_time (const std::string &format, const bpt::time_duration &t)
	formats a boost time duration according to a custom format string
blt::local_date_time	parse_date_time (const std::string &format, const std::string &t)
	converts a custom formatted datetime string to a boost local_date_time
std::string	encode_xml_datetime (const bpt::ptime &t)
	returns a string representation suitable for an xsd:datetime attribute; input is assumed to be UTC time; output string is UTC time (as denoted by the 'Z' suffix)
std::string	encode_xml_datetime (const blt::local_date_time &t)
	returns a string representation suitable for an xsd:datetime attribute; time zone is assumed to be correct; output string is UTC time (as denoted by the 'Z' suffix)
blt::local_date_time	decode_xml_datetime (const std::string &t)
	converts an xsd:datetime attribute to a local_date_time
	BOOST_STATIC_ASSERT (sizeof(unsigned int)==4)
	BOOST_STATIC_ASSERT (sizeof(unsigned long long)==8)
unsigned int	endianize32 (unsigned int n)
unsigned long long	endianize64 (unsigned long long n)
PWIZ_API_DECL int	expand_pathmask (const bfs::path &pathmask, vector< bfs::path > &matchingPaths)
	expands (aka globs) a pathmask to zero or more matching paths and returns the number of matching paths
PWIZ_API_DECL std::string	abbreviate_byte_size (boost::uintmax_t byteSize, ByteSizeAbbreviation abbreviationType=ByteSizeAbbreviation_SI)
	abbreviates a byte size (file or RAM) as a readable string, using the specified notation
PWIZ_API_DECL std::string	read_file_header (const std::string &filepath, size_t length=512)
Image::Point	operator+ (const Image::Point &a, const Image::Point &b)
Image::Point	operator- (const Image::Point &a, const Image::Point &b)
template<typename SequenceT >
std::string	longestCommonPrefix (const SequenceT &strings)
std::string	unit_assert_message (const char *filename, int line, const char *expression)
std::string	unit_assert_equal_message (const char *filename, int line, const std::string &x, const std::string &y, const char *expression)
std::string	unit_assert_numeric_equal_message (const char *filename, int line, double x, double y, double epsilon)
std::string	unit_assert_exception_message (const char *filename, int line, const char *expression, const std::string &exception)
std::string	escape_teamcity_string (const std::string &str)
PWIZ_API_DECL int	testReader (const pwiz::msdata::Reader &reader, const std::vector< std::string > &args, bool testAcceptOnly, const TestPathPredicate &isPathTestable)
	A common test harness for vendor readers;.

Variables
static once_flag_proxy	init_once_flag_proxy = {BOOST_ONCE_INIT}
	this proxy class can be used for initializing per-instance once_flag_proxy(s)

---

Typedef Documentation

typedef boost::shared_ptr<IterationListener> pwiz::util::IterationListenerPtr

Definition at line 60 of file IterationListener.hpp.

typedef boost::iostreams::stream_offset pwiz::util::random_access_compressed_ifstream_off_t

Definition at line 78 of file random_access_compressed_ifstream.hpp.

---

Enumeration Type Documentation

enum pwiz::util::ByteSizeAbbreviation

Enumerator:

ByteSizeAbbreviation_IEC	sizes are treated as multiples of 2; abbreviations are: GiB (Gibibyte), MiB (Mebibyte), KiB (Kibibyte), B (byte)
ByteSizeAbbreviation_JEDEC	sizes are treated as multiples of 2; abbreviations are: GB (Gigabyte), MB (Megabyte), KB (Kilobyte), B (byte)
ByteSizeAbbreviation_SI	sizes are treated as multiples of 10; abbreviations are: GB (Gigabyte), MB (Megabyte), KB (Kilobyte), B (byte)

Definition at line 75 of file Filesystem.hpp.

{
    /// sizes are treated as multiples of 2;
    /// abbreviations are: GiB (Gibibyte), MiB (Mebibyte), KiB (Kibibyte), B (byte)
    ByteSizeAbbreviation_IEC,

    /// sizes are treated as multiples of 2;
    /// abbreviations are: GB (Gigabyte), MB (Megabyte), KB (Kilobyte), B (byte)
    ByteSizeAbbreviation_JEDEC,

    /// sizes are treated as multiples of 10;
    /// abbreviations are: GB (Gigabyte), MB (Megabyte), KB (Kilobyte), B (byte)
    ByteSizeAbbreviation_SI
};

---

Function Documentation

template<typename float_type >

bool pwiz::util::almost_equal	(	float_type	a,
		float_type	b,
		int	multiplier = 1
	)

Definition at line 37 of file almost_equal.hpp.

References epsilon.

Referenced by test_default_double(), test_default_float(), and test_multiplier().

{
    float_type scale = a==float_type(0.0) ? float_type(1.0) : a;
    return std::abs((a-b)/scale) < float_type(multiplier) * std::numeric_limits<float_type>::epsilon();
}

std::string pwiz::util::ToStdString ( System::String^  source )

inline

Definition at line 41 of file cpp_cli_utilities.hpp.

{
    if (System::String::IsNullOrEmpty(source))
        return std::string();

        int len = (( source->Length+1) * 2);
        char *ch = new char[ len ];
        bool result ;
        {
                pin_ptr<const wchar_t> wch = PtrToStringChars( source );
                result = wcstombs( ch, wch, len ) != -1;
        }
        std::string target = ch;
        delete ch;
        if(!result)
        throw gcnew System::Exception("error converting System::String to std::string");
        return target;
}

System::String pwiz::util::ToSystemString ( const std::string &  source )

inline

Definition at line 61 of file cpp_cli_utilities.hpp.

{
    return gcnew System::String(source.c_str());
}

template<typename managed_value_type , typename native_value_type >

void pwiz::util::ToStdVector	(	cli::array< managed_value_type >^	managedArray,
		std::vector< native_value_type > &	stdVector
	)

Definition at line 68 of file cpp_cli_utilities.hpp.

{
    stdVector.clear();
    if (managedArray->Length > 0)
    {
        cli::pin_ptr<managed_value_type> pin = &managedArray[0];
        native_value_type* begin = (native_value_type*) pin;
        stdVector.assign(begin, begin + managedArray->Length);
    }
}

template<typename managed_value_type , typename native_value_type >

void pwiz::util::ToAutomationVector	(	cli::array< managed_value_type >^	managedArray,
		automation_vector< native_value_type > &	automationArray
	)

wraps a managed array in an automation_vector to enable direct access from unmanaged code

Definition at line 82 of file cpp_cli_utilities.hpp.

{
    VARIANT v;
    ::VariantInit(&v);
    System::IntPtr vPtr = (System::IntPtr) &v;
    System::Runtime::InteropServices::Marshal::GetNativeVariantForObject((System::Object^) managedArray, vPtr);
    automationArray.attach(v);
}

std::string pwiz::util::format_date_time ( const std::string &  format, const bpt::ptime &  t  )

inline

formats a boost ptime according to a custom format string

Definition at line 81 of file DateTime.hpp.

Referenced by encode_xml_datetime(), test_format_date_time(), and test_parse_date_time().

{
    bpt::time_facet* output_facet = new bpt::time_facet;
    output_facet->format(format.c_str());
    std::ostringstream ss;
    ss.imbue(std::locale(std::locale::classic(), output_facet));
    return static_cast<std::ostringstream&>(ss << t).str();
}

std::string pwiz::util::format_date_time ( const std::string &  format, const blt::local_date_time &  t  )

inline

formats a boost local_date_time according to a custom format string

Definition at line 92 of file DateTime.hpp.

{
    blt::local_time_facet* output_facet = new blt::local_time_facet;
    output_facet->format(format.c_str());
    std::ostringstream ss;
    ss.imbue(std::locale(std::locale::classic(), output_facet));
    return static_cast<std::ostringstream&>(ss << t).str();
}

std::string pwiz::util::format_date_time ( const std::string &  format, const bpt::time_duration &  t  )

inline

formats a boost time duration according to a custom format string

Definition at line 103 of file DateTime.hpp.

{
    bpt::time_facet* output_facet = new bpt::time_facet;
    output_facet->format(format.c_str());
    std::ostringstream ss;
    ss.imbue(std::locale(std::locale::classic(), output_facet));
    return static_cast<std::ostringstream&>(ss << t).str();
}

blt::local_date_time pwiz::util::parse_date_time ( const std::string &  format, const std::string &  t  )

inline

converts a custom formatted datetime string to a boost local_date_time

Definition at line 114 of file DateTime.hpp.

Referenced by test_parse_date_time().

{
    blt::local_time_input_facet* input_facet = new blt::local_time_input_facet;
    input_facet->format(format.c_str());
    std::istringstream ss(t);
    ss.imbue(std::locale(std::locale::classic(), input_facet));

    blt::local_date_time result(bdt::not_a_date_time);
    ss >> result;
    return result;
}

std::string pwiz::util::encode_xml_datetime ( const bpt::ptime &  t )

inline

returns a string representation suitable for an xsd:datetime attribute; input is assumed to be UTC time; output string is UTC time (as denoted by the 'Z' suffix)

Definition at line 130 of file DateTime.hpp.

References format_date_time().

Referenced by encode_xml_datetime(), and test_xml_datetime().

{
    // 2007-06-27T15:23:45Z
    return format_date_time("%Y-%m-%dT%H:%M:%SZ", t);
}

std::string pwiz::util::encode_xml_datetime ( const blt::local_date_time &  t )

inline

returns a string representation suitable for an xsd:datetime attribute; time zone is assumed to be correct; output string is UTC time (as denoted by the 'Z' suffix)

Definition at line 140 of file DateTime.hpp.

References encode_xml_datetime().

{
    // 2007-06-27T15:23:45Z
    return encode_xml_datetime(t.utc_time());
}

blt::local_date_time pwiz::util::decode_xml_datetime ( const std::string &  t )

inline

converts an xsd:datetime attribute to a local_date_time

Definition at line 148 of file DateTime.hpp.

Referenced by test_xml_datetime().

{
    blt::local_time_input_facet* input_facet = new blt::local_time_input_facet;
    input_facet->format("%Y-%m-%dT%H:%M:%SZ");
    std::stringstream ss(t);
    ss.imbue(std::locale(std::locale::classic(), input_facet));
    blt::local_date_time result(bdt::not_a_date_time);
    ss >> result;
    return blt::local_date_time(result.utc_time(), blt::time_zone_ptr());
}

pwiz::util::BOOST_STATIC_ASSERT

(

sizeof(unsigned int)

= =4

)

pwiz::util::BOOST_STATIC_ASSERT

(

sizeof(unsigned long long)

= =8

)

unsigned int pwiz::util::endianize32 ( unsigned int  n )

inline

Definition at line 74 of file endian.hpp.

Referenced by test().

{
    return ((n&0xff)<<24) | ((n&0xff00)<<8) | ((n&0xff0000)>>8) | ((n&0xff000000)>>24);
}

unsigned long long pwiz::util::endianize64 ( unsigned long long  n )

inline

Definition at line 80 of file endian.hpp.

Referenced by test().

{
    return ((n&0x00000000000000ffll)<<56) | 
           ((n&0x000000000000ff00ll)<<40) | 
           ((n&0x0000000000ff0000ll)<<24) | 
           ((n&0x00000000ff000000ll)<<8)  |
           ((n&0x000000ff00000000ll)>>8)  | 
           ((n&0x0000ff0000000000ll)>>24) |
           ((n&0x00ff000000000000ll)>>40) | 
           ((n&0xff00000000000000ll)>>56);
}

PWIZ_API_DECL int pwiz::util::expand_pathmask	(	const bfs::path &	pathmask,
		vector< bfs::path > &	matchingPaths
	)

expands (aka globs) a pathmask to zero or more matching paths and returns the number of matching paths

• matching paths can be either files or directories
• matching paths will be absolute if input pathmask was absolute
• matching paths will be relative if input pathmask was relative

Referenced by cleanTests(), Is_T2D_Directory::operator()(), and testExpandPathmask().

PWIZ_API_DECL std::string pwiz::util::abbreviate_byte_size	(	boost::uintmax_t	byteSize,
		ByteSizeAbbreviation	abbreviationType = ByteSizeAbbreviation_SI
	)

abbreviates a byte size (file or RAM) as a readable string, using the specified notation

Referenced by testAbbreviateByteSize().

PWIZ_API_DECL std::string pwiz::util::read_file_header	(	const std::string &	filepath,
		size_t	length = 512
	)

Image::Point pwiz::util::operator+ ( const Image::Point &  a, const Image::Point &  b  )

inline

Definition at line 105 of file Image.hpp.

References pwiz::util::Image::Point::x, and pwiz::util::Image::Point::y.

{
    return Image::Point(a.x+b.x, a.y+b.y);
}

Image::Point pwiz::util::operator- ( const Image::Point &  a, const Image::Point &  b  )

inline

Definition at line 111 of file Image.hpp.

References pwiz::util::Image::Point::x, and pwiz::util::Image::Point::y.

{
    return Image::Point(a.x-b.x, a.y-b.y);
}

template<typename SequenceT >

std::string pwiz::util::longestCommonPrefix

(

const SequenceT &

strings

)

Definition at line 58 of file String.hpp.

{
    if (strings.empty())
        return "";

    typename SequenceT::const_iterator itr = strings.begin();
    std::string result = *itr;
    for (++itr; itr != strings.end(); ++itr)
    {
        const std::string& target = *itr;

        if (result.empty())
            return "";

        for (size_t j=0; j < target.length() && j < result.length(); ++j)
            if (target[j] != result[j])
            {
                result.resize(j);
                break;
            }
    }
    return result;
}

std::string pwiz::util::unit_assert_message ( const char *  filename, int  line, const char *  expression  )

inline

Definition at line 52 of file unit.hpp.

{
    std::ostringstream oss;
    oss << "[" << filename << ":" << line << "] Assertion failed: " << expression;
    return oss.str();
}

std::string pwiz::util::unit_assert_equal_message ( const char *  filename, int  line, const std::string &  x, const std::string &  y, const char *  expression  )

inline

Definition at line 59 of file unit.hpp.

{
    std::ostringstream oss;
    oss << "[" << filename << ":" << line << "] Assertion failed: expected \"" << x << "\" but got \"" << y << "\" (" << expression << ")";
    return oss.str();
}

std::string pwiz::util::unit_assert_numeric_equal_message ( const char *  filename, int  line, double  x, double  y, double  epsilon  )

inline

Definition at line 66 of file unit.hpp.

References epsilon.

{
    std::ostringstream oss;
    oss.precision(10);
    oss << "[" << filename << ":" << line << "] Assertion failed: |" << x << " - " << y << "| < " << epsilon;
    return oss.str();
}

std::string pwiz::util::unit_assert_exception_message ( const char *  filename, int  line, const char *  expression, const std::string &  exception  )

inline

Definition at line 74 of file unit.hpp.

{
    std::ostringstream oss;
    oss << "[" << filename << ":" << line << "] Assertion failed to throw \"" << exception << "\": " << expression;
    return oss.str();
}

std::string pwiz::util::escape_teamcity_string ( const std::string &  str )

inline

Definition at line 133 of file unit.hpp.

{
    string result = str;
    bal::replace_all(result, "'", "|'");
    bal::replace_all(result, "\n", "|n");
    bal::replace_all(result, "\r", "|r");
    bal::replace_all(result, "|", "||");
    bal::replace_all(result, "[", "|[");
    bal::replace_all(result, "]", "|]");
    return result;
}

PWIZ_API_DECL int pwiz::util::testReader	(	const pwiz::msdata::Reader &	reader,
		const std::vector< std::string > &	args,
		bool	testAcceptOnly,
		const TestPathPredicate &	isPathTestable
	)

A common test harness for vendor readers;.

Referenced by main().

---

Variable Documentation

once_flag_proxy pwiz::util::init_once_flag_proxy = {BOOST_ONCE_INIT}

static

this proxy class can be used for initializing per-instance once_flag_proxy(s)

Definition at line 40 of file Once.hpp.