peerctrl.h

/*
Copyright (c) 2003-2008, Edward Powley
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, 
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    * Neither the name of BTDSys nor the names of its contributors may be used
      to endorse or promote products derived from this software without
      specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#pragma once

#include <vector>
#include <set>
#include <string>
#include <windows.h>

#ifndef __MACHINE_INTERFACE_H
#include "../mdk/MachineInterface.h"
#endif

enum
{
        GROUP_GLOBAL = 1,
        GROUP_TRACK = 2,
        GROUP_ATTRIBUTE = 'A', // strange choice, for backwards compatibility

        ALLOW_SWITCH    = 1 << 0,
        ALLOW_BYTE              = 1 << 1,
        ALLOW_NOTE              = 1 << 2,
        ALLOW_WORD              = 1 << 3,

        ALLOW_GLOBAL    = 1 << 4,
        ALLOW_TRACK             = 1 << 5,
        ALLOW_ATTRIBUTES = 1 << 6,

        ALLOW_ALL_TYPES = ALLOW_SWITCH | ALLOW_BYTE | ALLOW_NOTE | ALLOW_WORD,
        ALLOW_ALL_GROUPS = ALLOW_GLOBAL | ALLOW_TRACK,

        TRACK_DEFAULT = -1,

        EVENT_HANDLER_ADD               = 1 << 0,
        EVENT_HANDLER_DELETE    = 1 << 1,
        EVENT_HANDLER_RENAME    = 1 << 2,
        ALL_EVENT_HANDLERS = EVENT_HANDLER_ADD | EVENT_HANDLER_DELETE | EVENT_HANDLER_RENAME,
};

class PeerCtrlException : public std::exception
{
public:
        PeerCtrlException(const char* msg) { m_msg = msg; }
        
        virtual const char* what() const throw() { return m_msg; }

protected:
        const char* m_msg;
};

class CPeerCtrl
{
public:

        static bool OnAddMachine(CMachine *pmac);

        static bool OnDeleteMachine(CMachine *pmac);

        static void SetEventHandlers(CMICallbacks *pCB, int which = ALL_EVENT_HANDLERS);


        CPeerCtrl();

        CPeerCtrl(CMachine *pmac, CMachineInterface *pmi);

        ~CPeerCtrl();

        void Init(CMachine *pmac, CMachineInterface *pmi);

        void SetLabel(const std::string& label);

        void SetLabel(const char* label);

        void SetLabelAsTrackNumber(int t);


        void ReadFileData(CMachineDataInput * const pi);

        void PushFileData(const char* macname, int paramnum, int group);

        void WriteFileData(CMachineDataOutput * const po, bool backwardsCompatible = false);


        void AssignParameter(CMachine *pMachine, int group, int param, int track = TRACK_DEFAULT);

        void UnassignParameter();


        CMachine *GetMachine();
        char const *GetMachineName();
        CMachineInfo const *GetMInfo();
        CMachineParameter const *GetParamInfo();
        char const *GetParamString();

        char const *GetAssignmentString();

        int GetParamNumber_Grouped();

        int GetParamNumber_Ungrouped();

        int GetGroup();

        bool GotParam();


        static void BeginImmediateBatch();

        static void EndImmediateBatch();


#       ifdef PEERLIB_NEXTTICK

        void ControlChange_NextTick (int track, int value);
        
        void ControlChange_NextTick (int value) { ControlChange_NextTick(TRACK_DEFAULT, value); }
#       endif
        
        void ControlChange_Immediate(int track, int value);

        void ControlChange_Immediate(int value) { ControlChange_Immediate(TRACK_DEFAULT, value); }


        virtual void onChangeAssignment() {}


        int  GetMachineNamesToCombo     (HWND hWnd, int ComboID, const char *ExcludeName);

        int  GetParamNamesToList        (CMachine *pmac, HWND hWnd, int ListID , int TypesAllowed);

        int  GetParamNamesToCombo       (CMachine *pmac, HWND hWnd, int ComboID, int TypesAllowed);

        bool SelectMachineInCombo       (HWND hWnd, int ComboID);

        bool SelectParameterInList      (HWND hWnd, int ListID);

        bool SelectParameterInCombo     (HWND hWnd, int ComboID);

        void AssignParameter(char *MacName, char *ParaName, int track = TRACK_DEFAULT);


        static void ShowPAL();


protected:
        bool m_initialised;
        CMICallbacks *pCB;
        CMachine *m_parentmac;
        CMachineInterface *m_parentmi;
        std::string m_label;

        CMachine *m_targetmac;
        int m_paramn, m_group, m_track;
        char m_loadedname[256];

        CMachineParameter m_attrAsParam;

        int GetParamNamesToDlgItem(CMachine *pmac, HWND DlgItem, int AddMessage, int TypesAllowed);
        int  FindMachine(HWND DlgItem, int SelectStringMessage);
        bool FindParam(HWND DlgItem, int SelectStringMessage);

        bool FindJustLoadedMachine();

protected:
        static std::vector<CPeerCtrl*> s_instances;

        static bool s_initialised;
        static void InitStatic(CMachine *pmac, CMachineInterface *pmi);
        static int s_hostversion;
        
        static bool s_immediatebatchmode;
        static std::set<CMachine*> s_immediatebatch, s_attributebatch;

        static HMODULE s_palModule;

        // Function pointers from PAL dll
        typedef void (__cdecl *pf_addCMICallbacks)(CMICallbacks*);
        typedef void (__cdecl *pf_setPeerAssignment)(
                void* ctrl, CMachine* source, const char* label,
                CMachine* target, int group, int param, int track);

        // Notify PAL of the current assignment.
        void tellPAL();
};

---