StringVector.h

Go to the documentation of this file.

/*CXXR $Id: StringVector.h 1351 2013-03-08 15:12:28Z arr $
 *CXXR
 *CXXR This file is part of CXXR, a project to refactor the R interpreter
 *CXXR into C++.  It may consist in whole or in part of program code and
 *CXXR documentation taken from the R project itself, incorporated into
 *CXXR CXXR (and possibly MODIFIED) under the terms of the GNU General Public
 *CXXR Licence.
 *CXXR 
 *CXXR CXXR is Copyright (C) 2008-13 Andrew R. Runnalls, subject to such other
 *CXXR copyrights and copyright restrictions as may be stated below.
 *CXXR 
 *CXXR CXXR is not part of the R project, and bugs and other issues should
 *CXXR not be reported via r-bugs or other R project channels; instead refer
 *CXXR to the CXXR website.
 *CXXR */

/*
 *  R : A Computer Language for Statistical Data Analysis
 *  Copyright (C) 1995, 1996  Robert Gentleman and Ross Ihaka
 *  Copyright (C) 1999-2006   The R Development Core Team.
 *  Andrew Runnalls (C) 2008
 *
 *  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.1 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, a copy is available at
 *  http://www.r-project.org/Licenses/
 */

#ifndef STRINGVECTOR_H
#define STRINGVECTOR_H

#include "CXXR/String.h"

#ifdef __cplusplus

#include <iostream>

#include "CXXR/FixedVector.hpp"
#include "CXXR/SEXP_downcast.hpp"

namespace CXXR {
    // Template specializations:
    namespace ElementTraits {
        template <>
        struct NAFunc<RHandle<String> > {
            const RHandle<String>& operator()() const
            {
                static RHandle<String> na(String::NA());
                return na;
            }
        };

        template <>
        struct IsNA<RHandle<String> > {
            bool operator()(const RHandle<String>& t) const
            {
                typedef RHandle<String> T;
                return t == NA<T>();
            }
        };
    }

    // Make the default handle for a String point to a blank string:
    template <>
    inline RHandle<String>::RHandle()
        : GCEdge<String>(String::blank())
    {}

    template <>
    inline const char* FixedVector<RHandle<String>, STRSXP>::staticTypeName()
    {
        return "character";
    }

    typedef FixedVector<RHandle<String>, STRSXP> StringVector;

    inline StringVector* asStringVector(const std::string& str,
                                        cetype_t encoding = CE_NATIVE)
    {
        GCStackRoot<String> cs(String::obtain(str, encoding));
        return CXXR_NEW(StringVector(1, cs));
    }

    void strdump(std::ostream& os, const StringVector& sv,
                 std::size_t margin = 0);
}  // namespace CXXR

BOOST_CLASS_EXPORT_KEY(CXXR::StringVector)

extern "C" {
#endif /* __cplusplus */

#ifndef __cplusplus
    Rboolean Rf_isString(SEXP s);
#else
    inline Rboolean Rf_isString(SEXP s)
    {
        return Rboolean(s && TYPEOF(s) == STRSXP);
    }
#endif

void SET_STRING_ELT(SEXP x, int i, SEXP v);

#ifndef __cplusplus
SEXP STRING_ELT(SEXP x, int i);
#else
inline SEXP STRING_ELT(SEXP x, int i)
{
    using namespace CXXR;
    return (*SEXP_downcast<StringVector*>(x, false))[i];
}
#endif

#ifdef __cplusplus
}
#endif

#endif /* STRINGVECTOR_H */