system_string.h

Go to the documentation of this file.

#ifndef SYSTEM_STRING_CLASS
#define SYSTEM_STRING_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : system_string                                                     *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Insert purpose here....                                                  *
*    Encapsulates the details of transforming various character string        *
*  formats into the underlying window system string format.                   *
*                                                                             *
*******************************************************************************
* Copyright (c) 1991-$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                               *
\*****************************************************************************/

// note: This class is a pretty ugly collection of kludges currently and should
// be cleaned up significantly.  One helpful idea would be better comments
// for each of the methods.

#include "definitions_passive.h"

// CAUTION: INDEX_SEPARATE (below) temporarily does not work.

enum concatenation_method
  { EOL_SEPARATE, SPACE_SEPARATE, INDEX_SEPARATE, DO_NOT_SEPARATE };
  // used in the constructor that works on multiple strings.  EOL_SEPARATE
  // means that the windowing system's string separators are used within the
  // created system_string at places where carriage returns (\n) are found.
  // SPACE_SEPARATE means that the strings are to be separated by a single
  // space character.  INDEX_SEPARATE means that the strings are separated
  // at the same places where each piece of text begins in the multiple
  // strings.  DO_NOT_SEPARATE means that the strings are jammed together
  // without separators.

class WP_PASSIVE_CLASS_STYLE system_string
{
public:
  system_string(const char *str = NIL);
    // Converts a simple character string.

  system_string(const istring &str);
    // Converts one of our dynamic strings.

  system_string(int n, const char *lines[], concatenation_method how);
    // Converts a set of "n" lines of text.

  ~system_string();

  operator window_string () const;
    // returns this string in the form that the underlying windowing system
    // expects.

private:
  window_string contents;
};

int compound_string_length(const char *to_count[]);
  // returns the number of string chunks held in "to_count", where the last
  // element in "to_count" should hold a zero character pointer.

#endif

---