PLearn 0.1
RPPath.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RPPath.cc
00004 //
00005 // Copyright (C) 2008 Olivier Delalleau
00006 //
00007 // Redistribution and use in source and binary forms, with or without
00008 // modification, are permitted provided that the following conditions are met:
00009 //
00010 //  1. Redistributions of source code must retain the above copyright
00011 //     notice, this list of conditions and the following disclaimer.
00012 //
00013 //  2. Redistributions in binary form must reproduce the above copyright
00014 //     notice, this list of conditions and the following disclaimer in the
00015 //     documentation and/or other materials provided with the distribution.
00016 //
00017 //  3. The name of the authors may not be used to endorse or promote
00018 //     products derived from this software without specific prior written
00019 //     permission.
00020 //
00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 //
00032 // This file is part of the PLearn library. For more information on the PLearn
00033 // library, go to the PLearn Web site at www.plearn.org
00034 
00035 // Authors: Olivier Delalleau
00036 
00040 #include "RPPath.h"
00041 
00042 namespace PLearn {
00043 using namespace std;
00044 
00045 PLEARN_IMPLEMENT_OBJECT(
00046     RPPath,
00047     "Remote interface for a PPath",
00048     "This class is intended to manipulate file and directory paths from\n"
00049     "outside PLearn.\n"
00050     "Currently it can only be used to convert a PPath to its absolute or\n"
00051     "canonical representation, but more forwarded methods may be added in\n"
00052     "the future."
00053 
00054 );
00055 
00057 // RPPath //
00059 RPPath::RPPath()
00060 {}
00061 
00063 // declareOptions //
00065 void RPPath::declareOptions(OptionList& ol)
00066 {
00067     declareOption(ol, "path", &RPPath::path,
00068             OptionBase::buildoption,
00069         "Path (to file or directory) that is being manipulated.");
00070 
00071     // Now call the parent class' declareOptions
00072     inherited::declareOptions(ol);
00073 }
00074 
00076 // declareMethods //
00078 void RPPath::declareMethods(RemoteMethodMap& rmm)
00079 {
00080     rmm.inherited(inherited::_getRemoteMethodMap_());
00081 
00082     declareMethod(rmm, "absolute", &RPPath::absolute,
00083             (BodyDoc("Return the absolute path as a RPPath object.")));
00084 
00085     declareMethod(rmm, "canonical", &RPPath::canonical,
00086             (BodyDoc("Return the canonic path.")));
00087 }
00088 
00090 // build //
00092 void RPPath::build()
00093 {
00094     inherited::build();
00095     build_();
00096 }
00097 
00099 // build_ //
00101 void RPPath::build_()
00102 {}
00103 
00105 // absolute //
00107 PP<RPPath> RPPath::absolute()
00108 {
00109     PP<RPPath> abs_path = new RPPath();
00110     abs_path->path = path.absolute();
00111     abs_path->build();
00112     return abs_path;
00113 }
00114 
00116 // canonical //
00118 string RPPath::canonical()
00119 {
00120     return path.canonical();
00121 }
00122 
00124 // makeDeepCopyFromShallowCopy //
00126 void RPPath::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00127 {
00128     inherited::makeDeepCopyFromShallowCopy(copies);
00129 }
00130 
00131 
00132 } // end of namespace PLearn
00133 
00134 
00135 /*
00136   Local Variables:
00137   mode:c++
00138   c-basic-offset:4
00139   c-file-style:"stroustrup"
00140   c-file-offsets:((innamespace . 0)(inline-open . 0))
00141   indent-tabs-mode:nil
00142   fill-column:79
00143   End:
00144 */
00145 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines