// Created on: 1994-06-01
// Created by: Christian CAILLET
// Copyright (c) 1994-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _StepSelect_FloatFormat_HeaderFile
#define _StepSelect_FloatFormat_HeaderFile

#include <Standard.hxx>
#include <Standard_Type.hxx>

#include <TCollection_AsciiString.hxx>
#include <StepSelect_FileModifier.hxx>
#include <Standard_Integer.hxx>
class IFSelect_ContextWrite;
class StepData_StepWriter;

class StepSelect_FloatFormat;
DEFINE_STANDARD_HANDLE(StepSelect_FloatFormat, StepSelect_FileModifier)

//! This class gives control out format for floatting values :
//! ZeroSuppress or no, Main Format, Format in Range (for values
//! around 1.), as StepWriter allows to manage it.
//! Formats are given under C-printf form
class StepSelect_FloatFormat : public StepSelect_FileModifier
{

public:
  //! Creates a new FloatFormat, with standard options :
  //! ZeroSuppress, Main Format = %E,
  //! Format between 0.001 and 1000. = %f
  Standard_EXPORT StepSelect_FloatFormat();

  //! Sets FloatFormat to default value (see Create) but if <digits>
  //! is given positive, it commands Formats (main and range) to
  //! ensure <digits> significant digits to be displayed
  Standard_EXPORT void SetDefault(const Standard_Integer digits = 0);

  //! Sets ZeroSuppress mode to a new value
  Standard_EXPORT void SetZeroSuppress(const Standard_Boolean mode);

  //! Sets Main Format to a new value
  //! Remark : SetFormat, SetZeroSuppress and SetFormatForRange are
  //! independent
  Standard_EXPORT void SetFormat(const Standard_CString format = "%E");

  //! Sets Format for Range to a new value with its range of
  //! application.
  //! To cancel it, give format as "" (empty string)
  //! Remark that if the condition (0. < Rmin < Rmax)  is not
  //! verified, this secondary format will be ignored.
  //! Moreover, this secondary format is intended to be used in a
  //! range around 1.
  Standard_EXPORT void SetFormatForRange(const Standard_CString format = "%f",
                                         const Standard_Real    Rmin   = 0.1,
                                         const Standard_Real    Rmax   = 1000.0);

  //! Returns all recorded parameters :
  //! zerosup  : ZeroSuppress status
  //! mainform : Main Format (which applies out of the range, or
  //! for every real if no range is set)
  //! hasrange : True if a FormatInRange is set, False else
  //! (following parameters do not apply if it is False)
  //! forminrange : Secondary Format (it applies inside the range)
  //! rangemin, rangemax : the range in which the secondary format
  //! applies
  Standard_EXPORT void Format(Standard_Boolean&        zerosup,
                              TCollection_AsciiString& mainform,
                              Standard_Boolean&        hasrange,
                              TCollection_AsciiString& forminrange,
                              Standard_Real&           rangemin,
                              Standard_Real&           rangemax) const;

  //! Sets the Floatting Formats of StepWriter to the recorded
  //! parameters
  Standard_EXPORT void Perform(IFSelect_ContextWrite& ctx,
                               StepData_StepWriter&   writer) const Standard_OVERRIDE;

  //! Returns specific Label : for instance,
  //! "Float Format [ZeroSuppress] %E [, in range R1-R2 %f]"
  Standard_EXPORT TCollection_AsciiString Label() const Standard_OVERRIDE;

  DEFINE_STANDARD_RTTIEXT(StepSelect_FloatFormat, StepSelect_FileModifier)

protected:
private:
  Standard_Boolean        thezerosup;
  TCollection_AsciiString themainform;
  TCollection_AsciiString theformrange;
  Standard_Real           therangemin;
  Standard_Real           therangemax;
};

#endif // _StepSelect_FloatFormat_HeaderFile
