db_backend_support.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 3 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef KICAD_DB_BACKEND_SUPPORT_H
#define KICAD_DB_BACKEND_SUPPORT_H
 
#include <chrono>
#include <functional>
#include <future>
#include <memory>
#include <mutex>
#include <optional>
#include <string>
#include <thread>
#include <vector>
 
#include <wx/string.h>
 
#include <database/database_backend.h>
#include "db_worker_thread.h"
 

inline std::string utf8( const wxString& aText )
{
    return std::string( aText.ToUTF8() );
}
 

struct DB_WORKER_FAILURE
{
    enum class CONNECTION
    {
        KEEP,  
        DROP,  
        FORGET 
    };
 
    DB_FAILURE  failure;
    std::string message;
    CONNECTION  connection;
};
 

DB_WORKER_FAILURE DescribeWorkerOutcome( DB_WORKER_THREAD::OUTCOME aOutcome, const std::string& aPath );
 

class DB_READ_DELIVERY
{
public:
    DB_READ_DELIVERY( std::vector<std::string>& aLabels, const DB_ROW_SINK& aSink );
 
    DB_READ_DELIVERY( const DB_READ_DELIVERY& ) = delete;
    DB_READ_DELIVERY& operator=( const DB_READ_DELIVERY& ) = delete;

    const std::shared_ptr<std::vector<std::string>>& Labels() const { return m_jobLabels; }

    const DB_ROW_SINK* Sink() const { return &m_deliver; }

    void Finish();

    bool SinkThrew() const { return m_sinkThrew; }

    static std::string SinkFailureMessage();
 
private:
    std::vector<std::string>&                 m_labels;
    const DB_ROW_SINK&                        m_sink;
    std::shared_ptr<std::vector<std::string>> m_jobLabels;
    DB_ROW_SINK                               m_deliver;
    bool                                      m_labelsCopied = false;
    bool                                      m_sinkThrew = false;
};
 

std::string ScrubSecret( std::string aText, const std::string& aSecret );
 

std::string RedactDetail( const std::string& aDetail, const std::string& aSecret );
 

template <typename T>
class DB_PROBE_LATCH
{
public:
    explicit DB_PROBE_LATCH( std::function<T()> aProbe ) :
            m_probe( std::move( aProbe ) )
    {
    }

    std::optional<T> Get( std::chrono::milliseconds aWait )
    {
        std::call_once( m_started,
                        [this]()
                        {
                            auto promise = std::make_shared<std::promise<T>>();
 
                            m_answer = promise->get_future().share();
 
                            std::thread(
                                    [promise, probe = m_probe]()
                                    {
                                        try
                                        {
                                            promise->set_value( probe() );
                                        }
                                        catch( ... )
                                        {
                                            promise->set_value( T() );
                                        }
                                    } )
                                    .detach();
                        } );
 
        const std::shared_future<T> answer = m_answer;
 
        if( answer.wait_for( aWait ) != std::future_status::ready )
            return std::nullopt;
 
        return answer.get();
    }
 
private:
    std::function<T()>    m_probe;
    std::once_flag        m_started;
    std::shared_future<T> m_answer;
};
 
#endif