eagletypeconverter.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_EAGLEIMPORT_EAGLETYPECONVERTER_H
#define LIBREPCB_EAGLEIMPORT_EAGLETYPECONVERTER_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <librepcb/core/attribute/attribute.h>
#include <librepcb/core/geometry/circle.h>
#include <librepcb/core/geometry/hole.h>
#include <librepcb/core/geometry/path.h>
#include <librepcb/core/geometry/polygon.h>
#include <librepcb/core/geometry/stroketext.h>
#include <librepcb/core/geometry/text.h>
#include <librepcb/core/geometry/zone.h>
#include <librepcb/core/library/cmp/componentprefix.h>
#include <librepcb/core/library/cmp/componentsymbolvariantitemsuffix.h>
#include <librepcb/core/library/pkg/footprintpad.h>
#include <librepcb/core/library/pkg/packagepad.h>
#include <librepcb/core/library/sym/symbolpin.h>
#include <librepcb/core/types/boundedunsignedratio.h>
#include <librepcb/core/types/circuitidentifier.h>
#include <librepcb/core/types/elementname.h>
#include <librepcb/core/types/point.h>
#include <librepcb/core/types/simplestring.h>
#include <parseagle/common/enums.h>
 
#include <QtCore>
 
#include <memory>
#include <optional>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace parseagle {
class Attribute;
class Circle;
class DeviceSet;
class Frame;
class Gate;
class Grid;
class Hole;
class Library;
class Package;
class Param;
class Pin;
class Polygon;
class Rectangle;
class SmtPad;
class Symbol;
class Text;
class ThtPad;
class Vertex;
class Wire;
struct Point;
}  // namespace parseagle
 
namespace librepcb {
 
class Layer;
class LengthUnit;
class MessageLogger;
 
namespace eagleimport {
 
/*******************************************************************************
 *  Class EagleTypeConverter
 ******************************************************************************/
 
class EagleTypeConverter final {
  Q_DECLARE_TR_FUNCTIONS(EagleTypeConverter)
 
public:
  // Types
 
  struct Geometry {
    int layerId;
    UnsignedLength lineWidth;
    bool filled;
    bool grabArea;
    Path path;
    std::optional<std::pair<Point, PositiveLength>> circle;
  };
 
  struct Pin {
    std::shared_ptr<SymbolPin> pin;
    std::shared_ptr<Circle> circle;
    std::shared_ptr<Polygon> polygon;
  };
 
  // Constructors / Destructor
  EagleTypeConverter() = delete;
  EagleTypeConverter(const EagleTypeConverter& other) = delete;
  ~EagleTypeConverter() = delete;
 
  static ElementName convertElementName(const QString& n);
 
  static QString convertElementDescription(const QString& d);
 
  static ElementName convertComponentName(QString n);
 
  static ElementName convertDeviceName(const QString& deviceSetName,
                                       const QString& deviceName);
 
  static ComponentPrefix convertComponentPrefix(const QString& p);
 
  static ComponentSymbolVariantItemSuffix convertGateName(const QString& n);
 
  static CircuitIdentifier convertPinOrPadName(const QString& n);
 
  static QString convertInversionSyntax(const QString& s) noexcept;
 
  static std::shared_ptr<Attribute> tryConvertAttribute(
      const parseagle::Attribute& a, MessageLogger& log);
 
  static void tryConvertAttributes(const QList<parseagle::Attribute>& in,
                                   AttributeList& out, MessageLogger& log);
 
  static void tryExtractMpnAndManufacturer(AttributeList& attributes,
                                           SimpleString& mpn,
                                           SimpleString& manufacturer) noexcept;
 
  static const Layer* tryConvertSchematicLayer(int id) noexcept;
 
  static const Layer* tryConvertBoardLayer(int id) noexcept;
 
  static QHash<const Layer*, const Layer*> convertLayerSetup(const QString& s);
 
  static Alignment convertAlignment(parseagle::Alignment a);
 
  static Length convertLength(double l);
 
  static UnsignedLength convertLineWidth(double w, int layerId);
 
  template <typename T>
  static T convertParamTo(const parseagle::Param& p);
 
  static Point convertPoint(const parseagle::Point& p);
 
  static Angle convertAngle(double a);
 
  static void convertGrid(const parseagle::Grid& g, PositiveLength& interval,
                          LengthUnit& unit);
 
  static Vertex convertVertex(const parseagle::Vertex& v);
 
  static Path convertVertices(const QList<parseagle::Vertex>& v, bool close);
 
  static QList<Geometry> convertAndJoinWires(
      const QList<parseagle::Wire>& wires, bool isGrabAreaIfClosed,
      MessageLogger& log);
 
  static Geometry convertRectangle(const parseagle::Rectangle& r,
                                   bool isGrabArea);
 
  static Geometry convertPolygon(const parseagle::Polygon& p, bool isGrabArea);
 
  static Geometry convertCircle(const parseagle::Circle& c, bool isGrabArea);
 
  static std::shared_ptr<Hole> convertHole(const parseagle::Hole& h);
 
  static Geometry convertFrame(const parseagle::Frame& f);
 
  static QString convertTextValue(const QString& v);
 
  static PositiveLength convertSchematicTextSize(double s);
 
  static std::shared_ptr<Text> tryConvertSchematicText(
      const parseagle::Text& t);
 
  static std::shared_ptr<Text> tryConvertSchematicAttribute(
      const parseagle::Attribute& t);
 
  static PositiveLength convertBoardTextSize(int layerId, double size);
 
  static UnsignedLength convertBoardTextStrokeWidth(int layerId, double size,
                                                    int ratio);
 
  static std::shared_ptr<StrokeText> tryConvertBoardText(
      const parseagle::Text& t);
 
  static std::shared_ptr<StrokeText> tryConvertBoardAttribute(
      const parseagle::Attribute& t);
 
  static Pin convertSymbolPin(const parseagle::Pin& p);
 
  static std::pair<std::shared_ptr<PackagePad>, std::shared_ptr<FootprintPad>>
      convertThtPad(const parseagle::ThtPad& p,
                    const BoundedUnsignedRatio& autoAnnularWidth);
 
  static std::pair<std::shared_ptr<PackagePad>, std::shared_ptr<FootprintPad>>
      convertSmtPad(const parseagle::SmtPad& p);
 
  static std::shared_ptr<Circle> tryConvertToSchematicCircle(const Geometry& g);
 
  static std::shared_ptr<Polygon> tryConvertToSchematicPolygon(
      const Geometry& g);
 
  static QVector<Path> convertBoardZoneOutline(const Path& outline,
                                               const Length& lineWidth);
 
  static QVector<std::shared_ptr<Zone>> tryConvertToBoardZones(
      const Geometry& g);
 
  static std::shared_ptr<Circle> tryConvertToBoardCircle(const Geometry& g);
 
  static std::shared_ptr<Polygon> tryConvertToBoardPolygon(const Geometry& g);
 
  static QString getLayerName(int id,
                              const QString& fallback = "unknown") noexcept;
 
  static BoundedUnsignedRatio getDefaultAutoThtAnnularWidth() noexcept;
 
  // Operator Overloadings
  EagleTypeConverter& operator=(const EagleTypeConverter& rhs) = delete;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace eagleimport
}  // namespace librepcb
 
#endif