# Tera Term Development

1. Development Environment
2. Libraries
3. Notice for SVN committer
4. Add entry to TERATERM.INI
5. Naming rule to add menu ID
6. What to do when new macro command is added?
7. How to build Libraries
8. How to build Tera Term
9. How to build TeraTerm Menu
10. How to build TTXKanjiMenu
11. How to build TTProxy
12. How to build TTSSH
13. How to build CygTerm
14. How to build TTXSamples
15. How to build HTML help file
16. How to release Tera Term installation package

## Development Environment

- OS
  - Windows XP Professional
  - Windows 8 Pro
  - Windows 8.1 Pro
  - Windows 10 Pro
- Compiler used for release in Tera Term Project
  - Visual Studio 2005 SP1 Standard Edition (or higher edition)
    - Service Pack 1 (VS80sp1-KB926601-X86-ENU.exe)
    - Microsoft Visual Studio 2005 Service Pack 1 MFC Security Update (VS80sp1-KB2538218-v2-X86-INTL.exe)
    - When Windows Vista or higher, Visual Studio 2005 Service Pack 1 Update for Windows Vista (VS80sp1-KB932232-X86-ENU.exe)
    - Windows Server 2003 R2 Platform SDK(Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 SP1)
      Note: The OpenSSL will not able to build by using the Visual Studio 2005 Standard Edition. So, install the Windows Server 2003 R2 Platform SDK to link the "Crypt32.Lib" library.
      Configure the INCLUDE and LIB environment variables to be given priority for the SDK installation directory.

          e.g. INCLUDE "C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2\Include"
               LIB     "C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2\Lib"

      Fix batch file C:\Program Files\Microsoft Visual Studio 8\Common7\Tools\vsvars32.bat
- Supported Compiler
  - Visual Studio 2005 (Added support from Tera Term 4.103)
    - with SDK 7.0
      - Windows Server 2003 R2 Platform SDK (= Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 SP1) (5.2.3790.2075.51.PlatformSDK_Svr2003R2_rtm.img)
        Note: unavailable on Microsoft website (at Apr 07, 2019).
    - with SDK 7.1
      - Microsoft Windows SDK for Windows 7 and .NET Framework 4 (GRMSDK_EN_DVD.iso)
      - To use with Visual Studio 2005, KB949009(VS80sp1-KB949009-X86-INTL.exe) or KB980422(VS80sp1-KB980422-x86-INTL.exe) is necessary.
        Note: KB949009 and KB980422 are unavailable on Microsoft website.
      built binary is able to run on Windows 95.
  - Visual Studio 2008 SP1 Standard Edition (or higher edition)
    Note: The executable program which was compiled by this version does not work on Windows NT 4.0, 95, 98 and Me.
  - Visual Studio 2010 SP1 Professional Edition (or higher edition)
    Note: The executable program which was compiled by this version does not work on Windows 2000, NT 4.0, 95, 98 and Me.
  - Visual Studio 2012 Update 4 Professional Edition (or higher edition)
    Note: The executable program which was compiled by this version does not work on Windows Vista, XP, 2000, NT 4.0, 95, 98 and Me.
  - Visual Studio Community 2013 Update 5
    - MFC MBCS DLL Add-on (vc_mbcsmfc.exe) is necessary.
    Note: The executable program which was compiled by this version does not work on Windows Vista, XP, 2000, NT 4.0, 95, 98 and Me.
  - Visual Studio Community 2015 Update 3
    Note: The executable program which was compiled by this version does not work on Windows Vista, XP, 2000, NT 4.0, 95, 98 and Me.
  - Visual Studio Community 2017
    Note: The executable program which was compiled by this version does not work on Windows Vista, XP, 2000, NT 4.0, 95, 98 and Me.
  - Visual Studio Community 2019
    Note: The executable program which was compiled by this version does not work on Windows Vista, XP, 2000, NT 4.0, 95, 98 and Me.
  - How to build with batch file:
    Please execute the batch file on command prompt of Visual Studio. Otherwise, please configure below environment variables.
    Please call "(x86) Native Tools Command Prompt" of your Visual Studio to register new PATH regarding the compiler path and VSINSTALLDIR variable.

        Example:
        INCLUDE       C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\INCLUDE;C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\ATLMFC\INCLUDE;C:\Program Files (x86)\Windows Kits\8.1\include\shared;C:\Program Files (x86)\Windows Kits\8.1\include\um;
        LIB           C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\LIB;C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\ATLMFC\LIB;C:\Program Files (x86)\Windows Kits\8.1\lib\winv6.3\um\x86;
        PATH          C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE;C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\BIN;C:\Program Files (x86)\Windows Kits\8.1\bin\x86
        VSINSTALLDIR  C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC

- Installer
  - Inno Setup 6.2.1 (https://jrsoftware.org/isinfo.php)
  - Inno Script Studio 2.5.1 (https://www.kymoto.org/products/inno-script-studio)
- Others
  - Cygwin the latest version (because CygTerm+ supports Vista or later from v4.105)
  - ActivePerl 5.10 or later version, Strawberry Perl 5.30.1.1 or later version
    converts character-code and return-code of documents for building OpenSSL.

## Libraries

- Oniguruma 6.9.8 (https://github.com/kkos/oniguruma/)
- SFMT 1.5.1 (http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/SFMT/index.html)
- LibreSSL 3.4.3 (https://www.libressl.org/)
- zlib 1.2.13 (https://www.zlib.net/)
- PuTTY 0.76 (https://www.chiark.greenend.org.uk/~sgtatham/putty/)
- The reference C implementation of Argon2 20190702 (https://github.com/P-H-C/phc-winner-argon2/)
- cJSON 1.7.14 (https://github.com/DaveGamble/cJSON/)

## Notice for SVN committer

SVN repository for committer is the following:

    svn+ssh://svn.osdn.net/svnroot/ttssh2/trunk

Should not edit checkout file in copying directory.
The other modification code may be deleted in SVN server when you commit checkout file. Also, fix it carefully when the conflicting occurs.

Should not have opened checkout file.
SVN commit procedure may be failure while checkout file will have been opened.

Edit language files
Use the text editor supporting multi languages(vim, EmEditor, Notepad++, etc) to edit the language files(installer\release\lang\*.lng).

## Add entry to TERATERM.INI

Entry name
Unfortunately, the confusing entries such as EnableFoo... and DisableBar... are included.
It recommends that the new name like as Baz....

## Naming rule to add menu ID

    The first digit is 5.

    The second digit is:
      Tera Term VT window         0
      Tera Term TEK window        1
      TTSSH                       2
      TTProxy                     3
      TTXKanjiMenu                4

    The third digit is:
      [File] menu                 1
      [Edit] menu                 2
      [Setup] menu                3
      [Control] menu              4
      [Window] menu               8
      [Help] menu                 9

Example: adding a TTSSH menu under File menu

    #define ID_SSHSCPMENU       52110

## What to do when new macro command is added?

- Coding
  - get a new number of command internal ID.
    ... teraterm/ttmacro/ttmparse.h
  - add a if statement to below function.
    ... CheckReservedWord@teraterm/ttmacro/ttmparse.c
  - add a caller doing the macro command.
    ... ExecCmnd@teraterm/ttmacro/ttl.c
  - make a function code for the macro command.
- Help topic
  - make the command help file.
    ... doc/LANG/html/macro/command/hogefunc.html
  - add the file to help topic.
    ... doc/LANG/teraterm.hhc
  - get a new number of context ID in help page.
    The value is internal ID + 92000.
    ... teraterm/common/helpid.h
  - make the alias between context ID and calling file.
    Open the .hhp file by using Text Editor, added a html line in [ALIAS] tag.
    ... doc/LANG/teraterm.hhp

## How to build Libraries

- PuTTY (used by TTSSH)
  1. Extract PuTTY source into libs/putty directory.
- Oniguruma (used by Tera Term Macro)
  1. Extract oniguruma source into libs/oniguruma directory.
  2. Launch 'Visual Studio 2005 Command Prompt' batch file from start menu.
  3. Move 'libs' directory on the command prompt. And run buildoniguruma6.bat.
- OpenSSL (used by TTSSH)
  1. Extract openssl source into libs/openssl directory.
  2. When the libs/openssl/Makefile.bak file exists on the OpenSSL 1.0.0e or later, delete the file only once
  3. Launch 'Visual Studio 2005 Command Prompt' batch file from start menu.
  4. Move 'libs' directory on the command prompt. And run buildopenssl11.bat.
- Zlib (used by TTSSH)
  1. Extract zlib source into libs/zlib directory.
  2. Launch 'Visual Studio 2005 Command Prompt' batch file from start menu.
  3. Move 'libs' directory on the command prompt. And run buildzlib.bat.
- SFMT (used by Tera Term Macro)
  1. Extract SFMT source into libs/SFMT directory.
  2. Launch 'Visual Studio 2005 Command Prompt' batch file from start menu.
  3. Move 'libs' directory on the command prompt. And run buildSFMT.bat.
  4. Modify version information in libs/SFMT/SFMT_version_for_teraterm.h if necessary.
- cJSON (used by TTXCheckUpdate plugin)
  1. Extract cJSON source into libs/cJSON directory.
- The reference C implementation of Argon2 (used by TTSSH)
  1. Extract argon2 source into libs/argon2 directory.

## How to build Tera Term

To build Tera Term source code is shown in the following step:
And you should use Visual Studio 2005 Standard Edition later version to build Tera Term because Tera Term program links MFC library (Visual Studio 2005 Express Edition can't be used).

1. Checkout Tera Term source code from OSDN(https://osdn.net/projects/ttssh2/).
2. Open teraterm\visualc\ttermpro.sln with Visual Studio.
   The linefeed code of .sln file must be "CR+LF".
3. Build Tera Term solution.
4. Tera Term execution program will be generated in teraterm\visualc\bin directory if the building is successful.

## How to build TeraTerm Menu

1. Checkout TeraTerm Menu source code from OSDN(https://osdn.net/projects/ttssh2/).
2. Open ttpmenu\ttpmenu.sln with Visual Studio.
3. Build ttpmenu solution.
4. ttpmenu.exe will be generated in Release directory if the building is successful.

## How to build TTXKanjiMenu

1. Checkout TTXKanjiMenu source code from OSDN(https://osdn.net/projects/ttssh2/).
2. Open TTXKanjiMenu\ttxkanjimenu.sln with Visual Studio.
3. Build ttpmenu solution.
4. ttxkanjimenu.dll will be generated in TTXKanjiMenu directory if the building is successful.

## How to build TTProxy

To build TTProxy source code is shown in the following step:
And you need Visual Studio 2005(VC++8.0) to build.

1. Checkout TTProxy source code from OSDN(https://osdn.net/projects/ttssh2/).
2. Open TTProxy\TTProxy.sln with Visual Studio.
3. Build TTProxy solution.
4. TTProxy DLL module will be generated in TTProxy directory if the building is successful.

## How to build TTSSH

To build TTSSH source code is shown in the following step:
And you need Visual Studio 2005(VC++8.0) and ActivePerl to build.

VS2005 Express Edition is able to build TTSSH. TTSSH links to ttpcmn.lib and it must be created beforehand. VS2005 Express Edition cannot build Tera Term, but it can create ttpcmn.lib

On VS2008 Express Edition, following error occurs:
.\ttxssh.rc(10) : fatal error RC1015: cannot open include file 'afxres.h'.
To avoid this error, edit ttxssh.rc file. Delete the line of "afxres.h", and add 2 lines.

    - #include "afxres.h"
    + #include
    + #define IDC_STATIC -1

1. Checkout TTSSH source code from OSDN(https://osdn.net/projects/ttssh2/).
2. Open ttssh2\ttssh.sln with Visual Studio.
3. Build TTSSH solution.
4. TTSSH DLL will be generated in ttssh2\ttxssh directory if the building is successful.

## How to build CygTerm

To build CygTerm source code is shown in the following step:

1. Install Cygwin(https://www.cygwin.com/) to your PC.
2. Launch Cygwin shell and go to cygterm directory.

       # cd cygterm

3. Compile Cygterm.

       # make

## How to build TTXSamples

To build TTXSamples source code is shown in the following step:
And you need Visual Studio 2005(VC++8.0) to build. VS2005 Express Edition is able to build TTXSamples.

1. Checkout TTXSamples source code from OSDN(https://osdn.net/projects/ttssh2/).
2. Open TTXSamples\TTXSamples.sln with Visual Studio.
3. Build TTXSamples solution.
4. TTXSamples DLL module will be generated in TTXSamples directory if the building is successful.

## How to build HTML help file

To build HTML help file is shown in the following step:

1. Install HTML Help Compiler
   Installing Visual Studio (2017 or later) with "C++ MFC" option, HTML Help Compiler (hhc.exe) is installed.
2. Run doc\makechm.bat

## How to release Tera Term installation package

To release Tera Term installation package is shown in the following step:

### From start release until create RC

1. Confirm ticket and branches.
   - Confirm in project team.
     - Organize / decide whether to include bug fix / feature in this release or defer.
   - Merge branches
     - Verify trunk / 4-stable and working branches.
   - Close tickets.
2. Confirm tools, libraries, import sources.
   - Visual Studio (https://visualstudio.microsoft.com/)
   - Inno Setup (https://jrsoftware.org/isdl.php)
   - Oniguruma (https://github.com/kkos/oniguruma/)
   - SFMT (http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/SFMT/index-jp.html)
   - LibreSSL (https://www.libressl.org/)
   - zlib (http://www.zlib.net/)
   - PuTTY (http://www.chiark.greenend.org.uk/~sgtatham/putty/)
   - cJSON (https://github.com/DaveGamble/cJSON/)
   - The reference C implementation of Argon2 (https://github.com/P-H-C/phc-winner-argon2/)

### From create RC until release

1. Confirm documents.
2. Increment the version while RC release process.

   The binary is released for test in this timing. Prevent that old and new binary have same version number.

   - teraterm\common\tt-version.h
   - ttssh2\ttxssh\ttxssh-version.h
   - Onttpmenu\ttpmenu.rc // only modifying
   - TTProxy\TTProxy.rc // only modifying
   - TTXKanjiMenu\ttxkanjimenu.rc // only modifying

   By way of exception, CygTerm+ always upgrades not regarding Tera Term release process when the patch is committed.
   The release date is the day committed by a developer.
   Because user can get gcc compiler for free.

3. Increment the year of last publication of copyright notice if it is first release in this year.
   - teraterm\keycode\keycode-version.rc // VERSIONINFO
   - teraterm\teraterm\tt-version.rc // VERSIONINFO
   - teraterm\ttpcmn\ttpcmn-version.rc // VERSIONINFO
   - teraterm\ttpdlg\ttpdlg.rc // dialog
   - teraterm\ttpmacro\ttm-version.rc // VERSIONINFO
   - teraterm\ttptek\ttptek-version.rc // VERSIONINFO
   - ttssh2\ttxssh\ttxssh.rc // dialog
   - ttssh2\ttxssh\ttxssh-version.rc // VERSIONINFO
   - ttpmenu\ttpmenu.rc // dialog, VERSIONINFO
   - TTProxy\TTProxy.rc // dialog, VERSIONINFO(en), VERSIONINFO(ja)
   - TTXKanjiMenu\ttxkanjimenu.rc // VERSIONINFO
   - installer\teraterm.iss
   - installer\release\license.txt // Tera Term, TTSSH, Cygterm+, TTProxy, TeraTerm Menu, TTX KanjiMenu
   - doc\en\html\index.html
   - doc\en\html\about\copyright.html // Tera Term, TTSSH, Cygterm+, TTProxy, TeraTerm Menu, TTX KanjiMenu
   - doc\en\html\macro\index.html
   - doc\ja\html\index.html
   - doc\ja\html\about\copyright.html // Tera Term, TTSSH, Cygterm+, TTProxy, TeraTerm Menu, TTX KanjiMenu
   - doc\ja\html\macro\index.html
4. Replace 64bit Cygwin binary

5. Create installer.
   - Version up AppVer and add "RC" in teraterm.iss.

         - #define AppVer "4.105"
         + #define AppVer "4.106-RC1"

   - Comment out snapshot in teraterm.iss.

         - #define snapshot GetDateTimeString('yyyymmdd_hhnnss', '', '');
         + ;#define snapshot GetDateTimeString('yyyymmdd_hhnnss', '', '');

   - Change calling batch file to enable rebuild and create archive.

           [PreCompile]
           Name: makechm.bat
         - Name: build.bat
         - ;Name: build.bat; Parameters: rebuild
         + ;Name: build.bat
         + Name: build.bat; Parameters: rebuild

           [PostCompile]
         - ;Name: makearchive.bat; Parameters: release
         + Name: makearchive.bat; Parameters: release

   - Commit this state.
   - Open teraterm\installer\teraterm.iss with Inno Script Studio, and create installer by "Project"-"Compile."
   - Compress portable version with zip.
6. Test run installer, run and connect in all supported OS.
7. Add to OSDN Release
   - Add new release (e.g. "4.106 RC") to "Tera Term RC" Package.
   - Add installer and portable zip file to new release.
8. Announce RC release.
   - ttssh2-users mailing list
   - Twitter (https://twitter.com/Tera_Term)
9. Get feedbacks.

   If changed source code, redo "Confirm documents" and "Test run and connect in all supported OS."

### Release

1. Confirm documents. (same as above)
2. Modify release date.
   - html/about/hisotry.html
3. Create installer.
   - Change AppVer in teraterm.iss.

         - #define AppVer "4.106-RC1"
         + #define AppVer "4.106"

   - Open teraterm\installer\teraterm.iss with ISTool, and create installer by "Project"-"Compile Setup."
4. Commit this state.
5. Create SVN tag.
   The naming rule is `teraterm-version' (e.g. teraterm-4_106).

       svn copy -m "Release 4.106" \
           svn+ssh://svn.osdn.net/svnroot/ttssh2/branches/4-stable \
           svn+ssh://svn.osdn.net/svnroot/ttssh2/tags/teraterm-4_106

6. Re-checkout from svn tag.

   All source code is same as development branch. Only SVN revision is different.

7. Create installer.
   - Open teraterm\installer\teraterm.iss with Inno Script Studio, and create installer by "Project"-"Compile."
   - Compress portable version with zip.
8. Update OSDN project site.
   - add new release (e.g. "4.106") to "Tera Term" Package.
   - Add installer and portable zip file to new release.
   - Submit news.
9. Update OSDN project home page (https://ttssh2.osdn.jp).

   How to update project home page (in Japanese).

10. Announce release.
    - ttssh2-users mailing list
    - Twitter (https://twitter.com/Tera_Term)
      - Pin announce tweet.
11. Revert teraterm.iss in development branch.

        - ;#define snapshot GetDateTimeString('yyyymmdd_hhnnss', '', '');
        + #define snapshot GetDateTimeString('yyyymmdd_hhnnss', '', '');

          [PreCompile]
          Name: makechm.bat
        - ;Name: build.bat
        - Name: build.bat; Parameters: rebuild
        + Name: build.bat
        + ;Name: build.bat; Parameters: rebuild

          [PostCompile]
        - Name: makearchive.bat; Parameters: release
        + ;Name: makearchive.bat; Parameters: release

12. Update Chocolatey.

### About code freeze.

After code freeze, only critical bug fix is able to committed.
Code freeze start with RC commit in development branch, and end with revert teraterm.iss commit in development branch.