fontpreviewprovider.h

Go to the documentation of this file.

/*
  * Copyright 2020 Twilight
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
*/
#pragma once
#include <QVector>
#include <QPixmap>
#include <QQuickImageProvider>
#include <QString>
#include <QSize>
#include <QStringList>
#include <QColor>
#include <QCache>
 
#include <pse-common/types.h>
 
class SaveFileExpanded;

struct FontPreviewInstance
{
  FontPreviewInstance(QStringList idParts,
                      SaveFileExpanded* expanded,
                      QSize* size,
                      const QSize& requestedSize);

  enum : int {
    IdPartTileset = 0,
    IdPartType,
    IdPartFrame,
    IdPartWidth,
    IdPartHeight,
    IdPartBox,
    IdPart2Line,
    IdPartChop,
    IdPartBGColor,
    IdPartFGColor,
    IdPartPlaceHolder,
    IdPartStr,
    IdPart_END
  };
 
  // Tiles to draw a box with arrow
  // A box is 6 tiles tall and 20 tiles wide. It's contents are double spaced
  // so it can only hold 2 lines of text but gives it nice line-height and
  // it has no left margin but a right margin of 1 tile. This is because the
  // text sits right in the box but keeps it from overlapping the right bottom
  // arrow.
  static constexpr int boxTiles[] = {
    0x79,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7B,
    0x7C,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7C,
    0x7C,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7C,
    0x7C,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7C,
    0x7C,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0x7F,0xEE,0x7C,
    0x7D,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7A,0x7E
  }; 
 
  // Tile size
  static constexpr int tileSize = 8; 
 
  // Hard-coded in FontDB and in FrontPreviewProvider
  static constexpr int maxLines = 2; 
 
  // Spacing between mutliple lines
  static constexpr int lineHeightTiles = 1;
  static constexpr int lineHeight = lineHeightTiles * tileSize;
 
  // Width and Heights
  static constexpr int drawWidthTiles = 20;
  static constexpr int drawHeightLines1Tiles = 1;
  static constexpr int drawHeightLines2Tiles = 2 + lineHeightTiles;
  static constexpr int drawHeightBoxTiles = 6;
 
  static constexpr int drawWidth = drawWidthTiles * tileSize;
  static constexpr int drawHeightLines1 = drawHeightLines1Tiles * tileSize;
  static constexpr int drawHeightLines2 = drawHeightLines2Tiles * tileSize;
  static constexpr int drawHeightBox = drawHeightBoxTiles * tileSize;
 
  // Max str length
  static constexpr int maxStrLenTiles = drawWidthTiles * maxLines;
 
  void setup(QStringList idParts); 
 
  void getInputStr();      
  void getTiles();         
  void getResultingText(); 
  void getImageWidth();    
  void getImageHeight();   
  void getBaseImg();       
  void drawBox();          
  void drawFg();           
  void finishImg();        
  void postProcess();      
 
  void getPlayersName(); 
  void getRivalsName();  
 
  // From ID String
  QString tileset;   
  QString type;      
  int frame = 0;     
  int toWidth = 0;   
  int toHeight = 0;  
  bool box = false;  
  bool lines2 = false; 
  int chopLen = 0;   
  QColor bgColor;    
  QColor fgColor;    
  QString placeholder; 
  QString inputStr;  
 
  // Other vars
  QStringList idParts;                  
  QVector<QVector<var8>> resultingText; 
  QImage bgImg;        
  QImage baseImg;      
  QImage boxImg;       
  QImage fgImg;        
  QPixmap resultingImg; 
  QVector<QPixmap> tiles; 
  QString playersName; 
  QString rivalsName;  
  int imgWidth = 0;       
  int imgWidthTiles = 0;  
  int imgHeight = 0;      
  int imgHeightTiles = 0; 
 
  bool useFg = false; 
 
  // Provider Vars
  QSize* size = nullptr;          
  const QSize& requestedSize;     
 
  // Reference vars
  SaveFileExpanded* expanded = nullptr; 
};

struct FontPreviewCached
{
  QString playersName;  
  QString rivalsName;   
  QPixmap resultingImg; 
};

class FontPreviewProvider : public QQuickImageProvider
{
public:
  FontPreviewProvider(SaveFileExpanded* expanded); 
 
  // <tileset>/<type>/<frame>/<width>/<height>/<box>/<2-lines>/<max>/<bgColor>/<fgColor>/<placeholder>/<str>
  //  * <tileset> is the tileset, case-insensitive and spaces converted to
  //    underscores
  //  * <type> is the type, specifically "outdoor" or not is used here
  //  * <frame> can be any positive number, a full frame cycle completes in 8
  //    frames though so it's suggested to use multiple of 8 for smooth
  //    animation
  //  * <box> tells whether to render a textbox or not as a bg
  //    specifically "box" or not
  //  * <2-lines> tells whether to render on 2 lines or not
  //    specifically "2-lines" or not
  //  * <max> is maximum line length (Excluding placeholder), if not between
  //    1 and 21 then it will be set to 21
  //  * <bgColor> tells what background color it should be in any QColor format
  //  * <fgColor> tells what text color it should be in any QColor format
  //    "none" however is special and means don't paint
  //  * <str> is the font str to render
  //  * <placeholder> is text to put str into, use %% in placeholder to insert
  //    the str
  virtual QPixmap requestPixmap(const QString& id, QSize* size, const QSize& requestedSize) override;
  QPixmap getErrorImg(QSize* size, const QSize& requestedSize); 
 
  SaveFileExpanded* expanded = nullptr; 
};