File indexing completed on 2024-04-28 05:02:30

 /*
     SPDX-FileCopyrightText: 2004 Ace Jones acejones @users.sourceforge.net
     SPDX-FileCopyrightText: 2018 Ralf Habacker ralf.habacker @freenet.de
     SPDX-FileCopyrightText: 2020 Thomas Baumgart <tbaumgart@kde.org>
 
     This file is part of libalkimia.
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef ALKONLINEQUOTE_H
 #define ALKONLINEQUOTE_H
 
 #include <alkimia/alkvalue.h>
 
 #include <QObject>
 #include <QDateTime>
 #include <QString>
 #include <QMap>
 
 class AlkOnlineQuoteSource;
 class AlkOnlineQuotesProfile;
 
 typedef QMap<QDate, AlkValue> AlkDatePriceMap;
 
 /**
 Retrieves a price quote from a web-based quote source
 
 @author Ace Jones acejones @users.sourceforge.net
 */
 class ALK_EXPORT AlkOnlineQuote : public QObject
 {
     Q_OBJECT
 public:
     explicit AlkOnlineQuote(AlkOnlineQuotesProfile *profile = 0, QObject * = 0);
     ~AlkOnlineQuote();
 
     /**
      * Hold errors reported from price quote fetching and parsing
      *
      * The implementation provides a type safe way to use
      * bit operations like '|=' for combining values and '&'
      * for checking value presence.
      */
     class ALK_EXPORT Errors
     {
     public:
         enum Type {
             None,
             Data,
             Date,
             DateFormat,
             Price,
             Script,
             Source,
             Symbol,
             Success,
             Timeout,
             URL,
         };
 
         Errors();
         Errors(Type type);
         Errors& operator|=(Type t);
         bool operator &(Type t) const;
 
     protected:
         QList<Type> m_type;
     };
 
     AlkOnlineQuotesProfile *profile();
     void setProfile(AlkOnlineQuotesProfile *profile);
 
     /**
      * Set accepted language the online quote should be returned for
      *
      * @param language accepted language to set
      */
     void setAcceptLanguage(const QString &language);
 
     /**
      * Return actual used timeout for fetching online quotes
      * If the returned value is -1, no timeout has been set.
      * @return timeout
      */
     int timeout() const;
 
     /**
      * Set timeout for fetching online quotes
      * If the timeout is != -1, a request to retrieve online quotes will be aborted
      * if the time set with this function has been exceeded.
      * @param newTimeout timeout in millseconds
      */
     void setTimeout(int newTimeout);
 
     /**
      * Defines a date range within which the data is to be retrieved.
      * This range is only taken into account for data in CSV format and
      * provides online quotes via the `quotes` signal.
      * @param from first date to include the online quote
      * @param to last date to include the online quote
      */
     void setDateRange(const QDate &from, const QDate &to);
 
     /**
      * Always use signal `quote`.
      * For online sources in CSV data format (see AlkOnlineQuoteSource::DataFormat),
      * the quotes found are normally returned via the `quotes` signal,
      * which can be changed to the `quote` signal using this method.
      *
      * This means that sources in CSV format can be processed via the
      * same interface as other formats.
      * @param state Enable or disable use of the `quote` signal
      */
     void setUseSingleQuoteSignal(bool state);
 
     /**
      * Returns the status of whether the `quote` signal is always used
      * @return current state
      */
     bool useSingleQuoteSignal();
 
     const AlkOnlineQuoteSource &source() const;
 
 public Q_SLOTS:
     /**
       * This launches a web-based quote update for the given @p _symbol.
       * When the quote is received back from the web source, it will be
       * emitted on the 'quote' signal.
       *
       * If services do not provide a date, parsing of the date can be disabled
       * by specifying an empty date attribute of the given online source.
       *
       * If a timeout is set with @ref setTimeout() and the web source does not
       * return the requested data, the update will be aborted after this time.
       *
       * @param _symbol the trading symbol of the stock to fetch a price for
       * @param _id an arbitrary identifier, which will be emitted in the quote
       *                signal when a price is sent back.
       * @param _source the source of the quote (must be a valid value returned
       *                by quoteSources().  Send QString() to use the default
       *                source.
       * @return bool Whether the quote fetch process was launched successfully
       *              In case of failures it returns false and @ref errors()
       *              could be used to get error details.
       */
     bool launch(const QString &_symbol, const QString &_id, const QString &_source = QString());
 
     /**
       * If @ref launch() returns false, this method can be used to get details
       * about the errors that occurred.
       *
       * @return bit map of errors, see class @ref Errors for details
      */
     const AlkOnlineQuote::Errors &errors();
 
 Q_SIGNALS:
     void quote(QString id, QString symbol, QDate date, double price);
     void quotes(const QString &id, const QString &symbol, const AlkDatePriceMap &prices);
     void failed(QString id, QString symbol);
     void status(QString s);
     void error(QString s);
 
 private:
     class Private;
     Private *const d;
 
 protected:
     Private &d_ptr();
 
     friend class AlkOnlineQuotePrivateTest;
 };
 
 #endif // ALKONLINEQUOTE_H