logical_directory.hpp

Go to the documentation of this file.

#ifndef SAGA_SAGA_PACKAGES_DATA_REPLICA_LOGICAL_DIRECTORY_HPP
#define SAGA_SAGA_PACKAGES_DATA_REPLICA_LOGICAL_DIRECTORY_HPP

#if defined(__WAVE__)
#pragma wave option(preserve: 2, line: 1, output: "preprocessed/logical_directory.hpp")
#endif
//  Copyright (c) 2005-2009 Hartmut Kaiser
//  Copyright (c) 2007 Ole Weidner (oweidner@cct.lsu.edu)
// 
//  Distributed under the Boost Software License, Version 1.0. (See accompanying 
//  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

#if defined(__WAVE__)
#pragma wave option(output: null)
#endif

#if defined(_MSC_VER) && (_MSC_VER >= 1200)
#pragma once
#endif 

// include stl
#include <string>

// include dependent spec sections
#include <saga/saga/util.hpp>
#include <saga/saga/base.hpp>
#include <saga/saga/call.hpp>
#include <saga/saga/types.hpp>
#include <saga/saga/object.hpp>
#include <saga/saga/session.hpp>
#include <saga/saga/detail/attribute.hpp>

#include <saga/saga/packages/namespace/namespace_dir.hpp>
#include <saga/saga/packages/replica/logical_file.hpp>

// suppress warnings about dependent classes not being exported from the dll
#if defined(BOOST_MSVC)
#pragma warning(push)
#pragma warning(disable: 4251 4231 4275 4660)
#endif

#ifdef SAGA_DEBUG
#include <saga/saga/packages/replica/preprocessed/logical_directory.hpp>
#else

#if defined(__WAVE__)
#pragma wave option(preserve: 2, line: 1, output: "preprocessed/logical_directory.hpp")
#endif

namespace saga 
{
    namespace replica 
    {
        
        
        namespace metrics 
        {
            //  metric names for a advert entries
            char const* const logical_directory_created_entry = "logical_directory.CreatedEntry";
            char const* const logical_directory_modified_entry = "logical_directory.ModifiedEntry";
            char const* const logical_directory_deleted_entry = "logical_directory.DeletedEntry";
        }
        
        
        class SAGA_REPLICA_PACKAGE_EXPORT logical_directory 
        : public saga::name_space::directory,
        public saga::detail::attribute<logical_directory>
        {
        protected:

            friend class saga::impl::logical_directory;
            friend struct saga::detail::attribute<logical_directory>;  // needs to access get_impl()
            typedef saga::detail::attribute<logical_directory> attribute_base;
            typedef saga::name_space::directory::monitorable_base monitorable_base;
            
        private:
            // factory
            SAGA_CALL_CREATE_PRIV_3(session const&, saga::url, int)

            
            SAGA_CALL_PRIV_1(is_file, saga::url)

            // overload open methods from namespace_dir
            SAGA_CALL_PRIV_2(open, saga::url, int)
            SAGA_CALL_PRIV_2(open_dir, saga::url, int)
            SAGA_CALL_PRIV_3(find, std::string, std::vector<std::string>, int)
            
        protected:

            TR1::shared_ptr <saga::impl::logical_directory> get_impl_sp() const;
            saga::impl::logical_directory* get_impl() const;
            explicit logical_directory(saga::impl::logical_directory *impl);
            
        public:
            logical_directory (session const& s, saga::url url, 
                               int mode = saga::replica::ReadWrite);

            explicit logical_directory (saga::url url, 
                                        int mode = saga::replica::ReadWrite);

            explicit logical_directory (saga::object const& o);

            logical_directory (void);

            ~logical_directory (void);

            static logical_directory create(session const& s, saga::url url, 
                int mode = Read)
            {
                return logical_directory(s, url, mode);
            }
            SAGA_CALL_CREATE_3_DEF_1(session const&, saga::url, int, Read)

            
            static logical_directory create(saga::url url, int mode = Read)
            {
                return logical_directory(url, mode);
            }
            template <typename Tag>
            static saga::task create(saga::url url, int mode = Read)
            {
                return create<Tag>(detail::get_the_session(), url, mode);
            }

            logical_directory& operator=(saga::object const& o);

            bool is_file(saga::url url) 
            {
                saga::task t = is_filepriv(url, saga::task_base::Sync()); 
                return t.get_result<bool>();
            }
            SAGA_CALL_PUB_1_DEF_0(is_file, saga::url)
            
            
            saga::replica::logical_file open(saga::url url, 
                                             int flags = saga::replica::Read) 
            {
                saga::task t = openpriv(url, flags, saga::task_base::Sync()); 
                return t.get_result<saga::replica::logical_file>();
            }
            SAGA_CALL_PUB_2_DEF_1(open, saga::url, int, saga::replica::Read)
            
            
            saga::replica::logical_directory open_dir(saga::url url, 
                                                      int flags
                                                      = saga::replica::Read) 
            {
                saga::task t = open_dirpriv(url, flags, saga::task_base::Sync()); 
                return t.get_result<saga::replica::logical_directory>();
            }
            SAGA_CALL_PUB_2_DEF_1(open_dir, saga::url, int, saga::replica::Read)
            
            
            std::vector<saga::url> find(std::string name_pattern, 
                                        std::vector<std::string> key_pattern, 
                                        int flags = saga::replica::Recursive) 
            {
                saga::task t = findpriv(name_pattern, key_pattern, flags,
                                        saga::task_base::Sync()); 
                return t.get_result<std::vector<saga::url> >();
            }
            SAGA_CALL_PUB_3_DEF_1(find, std::string, std::vector<std::string>, 
                                  int, saga::replica::None)
        }; 
        
    }}

#if defined(__WAVE__)
#pragma wave option(output: null)
#endif

#endif // !defined(SAGA_DEBUG)

// re-enable warnings about dependent classes not being exported from the dll
#if defined(BOOST_MSVC)
#pragma warning(pop)
#endif

#endif // SAGA_SAGA_PACKAGES_DATA_REPLICA_LOGICAL_DIRECTORY_HPP