PrintToString.h

/*
 * Pinoccio Arduino Library - PrintToString class
 *
 * Copyright (c) 2014 Matthijs Kooijman <matthijs@stdin.nl>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of Pinoccio nor the names of its contributors may be used
 *   to endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


#include <Arduino.h>

/**
 * Print class that allows printing to a specific String object.
 */
class PrintToString : public Print {
  public:
    // Create a new PrintToString that will print to the given String
    // object.
    PrintToString(String &s) : s(s) {}

    size_t write(uint8_t c) {
      this->s += (char)c;
    }

    // TODO: Add a write(const uint8_t *, size_t) version, once
    // String::concat(const char *, unsigned int) is made public

    // Inherit the other write methods too
    using Print::write;

  protected:
    String &s;
};

/**
 * Function version of PrintToString. Intended to pass to bitlash, until
 * bitlash is modified to accept Print objects so we can use
 * PrintToString instead.
 *
 * This is a template function, since we'll need a new function for
 * every String we want to print to. This also means that we can only
 * print to Strings that are global variables with external linkage
 * (e.g. non-static).
 */
template <String *s>
void printToString(uint8_t c) {
  *s += (char)c;
}


/* Version of printToString for StringBuffers. Template arguments can't
 * do implicit or explicit casting, it seems, so we just have a separate
 * version. */
template <StringBuffer *s>
void printToString(uint8_t c) {
  *s += (char)c;
}