calcconfig.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#pragma once
 
#include "scdllapi.h"
 
#include <memory>
#include <string_view>
 
#include <o3tl/sorted_vector.hxx>
#include <formula/grammar.hxx>
#include <formula/opcode.hxx>
#include <rtl/ustring.hxx>
 
// have to match the registry values
enum ScRecalcOptions
{
    RECALC_ALWAYS = 0,
    RECALC_NEVER,
    RECALC_ASK,
};
 
// Env.var. SC_FORCE_CALCULATION can be used to force all calculation
// to be done using OpenCL or group threading (even for single cells).
enum ForceCalculationType
{
    ForceCalculationNone, // do not force anything
    ForceCalculationCore, // "core", use only non-threaded normal code
    ForceCalculationOpenCL, // "opencl", force OpenCL
    ForceCalculationThreads // "threads", force threaded code
};
 
struct SC_DLLPUBLIC ScCalcConfig
{
    // from most stringent to most relaxed
    enum class StringConversion
    {
        ILLEGAL, 
        ZERO, 
        UNAMBIGUOUS, 
        LOCALE 
    };
    formula::FormulaGrammar::AddressConvention meStringRefAddressSyntax;
    StringConversion meStringConversion;
    bool mbEmptyStringAsZero : 1;
    bool mbHasStringRefSyntax : 1;
 
    static bool isOpenCLEnabled();
    static bool isThreadingEnabled();
    static ForceCalculationType getForceCalculationType();
 
    bool mbOpenCLSubsetOnly : 1;
    bool mbOpenCLAutoSelect : 1;
    OUString maOpenCLDevice;
    sal_Int32 mnOpenCLMinimumFormulaGroupSize;
 
    typedef std::shared_ptr<o3tl::sorted_vector<OpCode>> OpCodeSet;
 
    OpCodeSet mpOpenCLSubsetOpCodes;
 
    ScCalcConfig();
 
    void setOpenCLConfigToDefault();
 
    void reset();
    void MergeDocumentSpecific(const ScCalcConfig& r);
    void SetStringRefSyntax(formula::FormulaGrammar::AddressConvention eConv);
 
    bool operator==(const ScCalcConfig& r) const;
    bool operator!=(const ScCalcConfig& r) const;
};
 
OUString ScOpCodeSetToSymbolicString(const ScCalcConfig::OpCodeSet& rOpCodes);
ScCalcConfig::OpCodeSet ScStringToOpCodeSet(std::u16string_view rOpCodes);
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */