AsciiModelFileDialog.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: NDEVR
File: AsciiModelFileDialog
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/AutoModelFileDialog.h>
#include <NDEVR/DesignParameter.h>
class QPushButton;
class QComboBox;
class QLabel;
namespace Ui
{
    class AsciiImportUI;
}
namespace NDEVR
{
    class File;
    class FieldChooser;
    class INIFactory;
    /**--------------------------------------------------------------------------------------------------
    \brief Stores the data for AsciiModelFileDialog user specified columns
    **/
    struct ColumnDetails
    {
        DesignParameter selected_option;
        Buffer<DesignParameter> available_options;
        TypeInfo type_info;
        bool has_decimals = false;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Default dialog shown when the user exports an ascii-or custom column style file.
    **/
    class AsciiModelFileDialog : public AutoModelFileDialog
    {
        Q_OBJECT
    public:
        enum AsciiError
        {
              e_valid
            , e_file_is_empty
        };
        AsciiModelFileDialog(bool is_import, ProgressInfo* log, QWidget* parent = nullptr);
        ~AsciiModelFileDialog();
 
        virtual void setRequests(const Buffer<FactoryParameters>& file) override;
        bool checkValidity();
        void enabledFormatChoosing(bool enabled);
        static FileFormat AsciiTemplateFormat();
        void updateOptions(FactoryOptions& new_options) override;
        
        virtual void setUUIDs(Buffer<UUID> models) override;
    protected:
        QSize sizeHint() const override;
        void predictDelimiter(AsciiOptions& options) const;
        void predictColumnType(AsciiOptions& options);
        void predictFirstLine(uint04& line, uint04& row_count) const;
        bool predictHasHeaders() const;
        void setupColumnHeaders();
        void setColumn(uint04 index, const DesignParameter& params);
        bool existsOutsideOf(uint04 index, const DesignParameter& params) const;
        bool existsBefore(uint04 index, const DesignParameter& params) const;
        Buffer<DesignParameter> getPossibleChannels(const String& option);
        Buffer<DesignParameter> getChannelWhitelist() const;
        Buffer<DesignParameter> getAvailableChannels(const Buffer<UUID>& models);
        virtual void filterModelsToExport() override;
        File templateFolder() const;
        AsciiError updateUIFromFile(AsciiOptions& options);
        AsciiError updateExportPreview();
        void setupDelimiterCombo();
        QMenu* createColumnMenu();
        void updateColumnsFromParams();
        AsciiOptions asciiOptions() const;
        void insertNewColumn(uint04 index);
        void updateUINow() override;
    public slots:
        void updateFromUISlot();
        void showColumnContextMenu(const QPoint& point);
        void selectColumn(uint04 column);
        void onFieldChooserEdited();
        void onFieldChooserAccepted();
        void onFieldChooserDeleted();
    protected:
        Ui::AsciiImportUI* ascii_ui;
        Buffer<ColumnDetails> m_column_details;
        uint04 m_line_preview_count = 60;
        uint04 m_selected_column = 0;
        QMenu* m_field_menu = nullptr;
        bool m_ignore_update = false;
        bool m_pulling_template = false;
        DynamicPointer<Scanner> m_scanner;
    };
}