byte_formatter.h

Go to the documentation of this file.

#ifndef BYTE_FORMATTER_CLASS
#define BYTE_FORMATTER_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : byte_formatter                                                    *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1992-$now By Author.  This program 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.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include <basis/astring.h>
#include <basis/definitions.h>
 
namespace textual {
 
 
class byte_formatter : public virtual basis::root_object
{
public:
  virtual ~byte_formatter() {}
 
  DEFINE_CLASS_NAME("byte_formatter");
 
  static void print_char(basis::abyte to_print, basis::astring &out,
        char replace = '_');
 
  static void print_chars(const basis::abyte *to_print, int length,
          basis::astring &out, char replace = '_');
 
  static void text_dump(basis::astring &output, const basis::abyte *location,
          basis::un_int length, basis::un_int label = 0, const char *eol = "\n");
 
  static basis::astring text_dump(const basis::abyte *location, basis::un_int length,
          basis::un_int label = 0, const char *eol = "\n");
 
  static void text_dump(basis::astring &output,
          const basis::byte_array &to_dump, basis::un_int label = 0, const char *eol = "\n");
  static basis::astring text_dump(const basis::byte_array &to_dump,
          basis::un_int label = 0, const char *eol = "\n");
 
  static void parse_dump(const basis::astring &dumped_form,
          basis::byte_array &bytes_found);
 
 
  static void bytes_to_string(const basis::byte_array &to_convert,
          basis::astring &as_string, bool space_delimited = true);
 
  static void string_to_bytes(const basis::astring &to_convert,
          basis::byte_array &as_array);
 
  static void bytes_to_string(const basis::abyte *to_convert, int length,
          basis::astring &as_string, bool space_delimited = true);
 
  static void string_to_bytes(const char *to_convert,
          basis::byte_array &as_array);
 
 
  static void bytes_to_shifted_string
          (const basis::byte_array &to_convert, basis::astring &as_string);
 
  static void shifted_string_to_bytes(const basis::astring &to_convert,
          basis::byte_array &as_array);
 
 
  // utility methods to help building the formatted strings.
 
  static void make_eight(basis::un_int num, basis::astring &out);
 
  static bool in_hex_range(char to_check);
};
 
} //namespace.
 
#endif