gpioconnector.h

/* Copyright © 2018-2025 Pascal JEAN, All rights reserved.
 * This file is part of the Piduino Library.
 *
 * The Piduino Library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * The Piduino Library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the Piduino Library; if not, see <http://www.gnu.org/licenses/>.
 */
#pragma once
 
#include <iostream>
#include <vector>
#include <piduino/gpiopin.h>
 
namespace Piduino {
 
  class Gpio;
  class GpioDevice;
 
  class Connector {
 
    public:
      friend class Pin;
      friend class Gpio;
 
      class Family {
        public:
          enum  Id {
            Header1X = 0, 
            Header2X,     
            Unknown = -1
          };
 
          Family (Id i = Unknown) : _id (i), _columns (-1), _fnum (nullptr) {
            setId (i);
          }
          virtual ~Family() {}
 
          inline Id id() const {
            return _id;
          }
 
          inline int columns() const {
            return _columns;
          }
 
          inline const std::string &name() const {
            return _name;
          }
 
          int pinNumber (int row, int column) const;
 
          void setId (Id i);
 
        private:
          typedef int (* PinNumberFunc) (int row, int column, int columns);
          Id _id;
          int _columns;
          PinNumberFunc _fnum;
          std::string _name;
      };
 
      class Descriptor {
        public:
          std::string name;
          int number;
          int rows;
          Family family;
          long long id; 
          std::vector<Pin::Descriptor> pin;
          // -- functions
          Descriptor (long long connectorId = -1, int connectorNumber = -1);
          bool insert (); 
          bool hasPin (const Pin::Descriptor & p) const;
          long long findId() const;
      };
 
      bool isOpen() const;
 
      const std::string & name() const;
 
      int number() const;
 
      int size() const;
 
      int rows() const;
 
      int columns() const;
 
      const Family & family() const;
 
      long long id() const;
 
      void setDebug (bool enable);
 
      bool isDebug() const;
 
      friend std::ostream& operator<< (std::ostream& os, const Connector * c);
 
      Gpio * gpio() const;
 
      //------------------------------------------------------------------------
      //                          Accès aux broches
      //------------------------------------------------------------------------
 
      Pin & pin (int num) const;
 
      const std::map<int, std::shared_ptr<Pin>> & pin ();
 
      Connector (Gpio * parent, Descriptor * desc);
 
      virtual ~Connector();
 
    protected:
      GpioDevice * device() const;
 
      bool open();
 
      void close();
 
      int pinNumber (int row, int column) const;
 
      void printHline (std::ostream & os) const;
 
      void printTitle (std::ostream & os) const;
 
      void printRow (std::ostream & os, int num) const;
 
      inline void setId (int i) {
        _descriptor->id = i;
      }
 
    private:
      bool _isopen;
      Gpio * _parent;
      Descriptor * _descriptor; // descripteur
      std::map<int, std::shared_ptr<Pin>> _pin; // toutes les broches
  };
}
/* ========================================================================== */