groffstudio

Version 0.12.0
2022-03-14

[Feature] If the installed version of troff is not detected as groff, a warning is displayed.
[Changed] On platforms which probably use a package manager (currently, Linux and BSDs), the "update check" checkbox is disabled and the related libraries are not referenced.
[Improved] When exiting groffstudio, the Save function from the "save" button is reused.
[Changed] Less capital letters.

      <Resources Count="1">
        <Resource_0 FileName="..\LICENSE" Type="RCDATA" ResourceName="LICENSE"/>
      </Resources>
    </General>
    <VersionInfo>
      <UseVersionInfo Value="True"/>
      <AutoIncrementBuild Value="True"/>
      <MinorVersionNr Value="12"/>
      <Attributes pvaPreRelease="True"/>
      <StringTable ProductName="groffstudio"/>
    </VersionInfo>
    <BuildModes>
      <Item Name="Default" Default="True"/>
    </BuildModes>
    <PublishOptions>

object MainForm: TMainForm
  Left = 2381
  Height = 692
  Top = 99
  Width = 981
  Caption = 'groffstudio'
  ClientHeight = 692
  ClientWidth = 981
  DefaultMonitor = dmPrimary
  OnClose = FormClose
  OnCreate = FormCreate
  LCLVersion = '2.3.0.0'
  object MainStatusBar: TStatusBar
    Left = 0
    Height = 23
    Top = 669
    Width = 981
    Panels = <    
      item
        Text = 'file name with save status'
        Width = 200
      end    
      item
        Text = 'build successful?'
        Width = 120
      end    
      item
        Text = 'update available'
        Width = 120
      end>
    SimplePanel = False
  end
  object ExtendedNotebook1: TExtendedNotebook
    Left = 8
    Height = 662
    Top = 8
    Width = 961
    ActivePage = tsEdit
    Anchors = [akTop, akLeft, akRight, akBottom]
    Style = tsFlatButtons
    TabIndex = 0
    TabOrder = 1
    object tsEdit: TTabSheet
      Caption = 'edit a groff document'
      ClientHeight = 631
      ClientWidth = 953
      ParentFont = False
      object GroupBox1: TGroupBox
        Left = 10
        Height = 66
        Top = 560
        Width = 933
        Align = alBottom
        BorderSpacing.Left = 10
        BorderSpacing.Right = 10
        BorderSpacing.Bottom = 5
        Caption = 'build'
        ClientHeight = 46
        ClientWidth = 929
        TabOrder = 0
        object Label1: TLabel
          Left = 184
          Height = 15
          Top = -4
          Width = 72
          Caption = 'macro to use:'

            'mom'
            'ms'
          )
          TabOrder = 0
          Text = '[ select ]'
        end
        object Label2: TLabel
          Left = 806
          Height = 15
          Top = -4
          Width = 78
          Anchors = [akTop, akRight]
          Caption = 'output format:'
          ParentColor = False
        end
        object rdPs: TRadioButton
          Left = 807
          Height = 19
          Top = 16
          Width = 71
          Anchors = [akTop, akRight]
          Caption = 'PostScript'
          OnChange = rdPsChange
          TabOrder = 1
        end
        object rdPdf: TRadioButton
          Left = 887
          Height = 19
          Top = 16
          Width = 39
          Anchors = [akTop, akRight]
          Caption = 'PDF'
          OnChange = rdPdfChange
          TabOrder = 2
        end
        object Label3: TLabel
          Left = 424
          Height = 15
          Top = -4
          Width = 76
          Anchors = [akTop, akRight]
          Caption = 'preprocessors:'
          ParentColor = False
        end
        object chkEqn: TCheckBox
          Left = 480
          Height = 19
          Top = 16
          Width = 38
          Anchors = [akTop, akRight]
          Caption = 'eqn'
          TabOrder = 3
        end
        object chkPic: TCheckBox
          Left = 566
          Height = 19
          Top = 16
          Width = 34
          Anchors = [akTop, akRight]
          Caption = 'pic'
          TabOrder = 4
        end
        object chkTbl: TCheckBox
          Left = 654
          Height = 19
          Top = 16
          Width = 32
          Anchors = [akTop, akRight]
          Caption = 'tbl'
          TabOrder = 5
        end
        object chkGrn: TCheckBox
          Left = 524
          Height = 19
          Top = 16
          Width = 36
          Anchors = [akTop, akRight]
          Caption = 'grn'
          TabOrder = 6
        end
        object chkChem: TCheckBox
          Left = 424
          Height = 19
          Top = 16
          Width = 48
          Anchors = [akTop, akRight]
          Caption = 'chem'
          TabOrder = 7
        end
        object chkRefer: TCheckBox
          Left = 606
          Height = 19
          Top = 16
          Width = 42
          Anchors = [akTop, akRight]
          Caption = 'refer'
          TabOrder = 8
        end
        object Label4: TLabel
          Left = 707
          Height = 15
          Top = -4
          Width = 34
          Anchors = [akTop, akRight]
          Caption = 'extras:'
          ParentColor = False
        end
        object chkPdfMark: TCheckBox
          Left = 708
          Height = 19
          Top = 16
          Width = 63
          Anchors = [akTop, akRight]
          Caption = 'Pdfmark'
          Enabled = False
          TabOrder = 9
        end
        object btnBuild: TButton
          Left = 0
          Height = 29
          Top = 10
          Width = 75
          Caption = 'build'
          Color = clLime
          Enabled = False
          Font.Style = [fsBold, fsItalic]
          OnClick = btnBuildClick
          ParentFont = False
          TabOrder = 10
        end
        object chkLogFile: TCheckBox
          Left = 80
          Height = 19
          Hint = 'If enabled, a log file containing the groff output will be placed alongside the source document.'
          Top = 16
          Width = 68
          Caption = 'log to file'
          Enabled = False
          TabOrder = 11
        end
















      end














      object btnSaveGroff: TButton
        Left = 868
        Height = 28
        Top = 528
        Width = 75
        Anchors = [akRight, akBottom]
        Caption = 'save'
        Font.Style = [fsBold]
        OnClick = btnSaveGroffClick
        ParentFont = False
        TabOrder = 1
      end
      object btnLoadGroff: TButton
        Left = 787
        Height = 28
        Top = 528
        Width = 75
        Anchors = [akRight, akBottom]
        Caption = 'load'
        Font.Style = [fsBold]
        OnClick = btnLoadGroffClick
        ParentFont = False
        TabOrder = 2
      end
      object Label5: TLabel
        Left = 331
        Height = 15
        Top = 541
        Width = 438
        Anchors = [akRight, akBottom]
        Caption = 'note that everything build-related will be stored in the document''s storage directory'
        Font.Color = clBlue
        Font.Style = [fsItalic]
        ParentColor = False
        ParentFont = False
      end
      inline SynEdit1: TSynEdit
        Left = 10
        Height = 523
        Top = 0
        Width = 933
        Anchors = [akTop, akLeft, akRight, akBottom]
        Font.CharSet = 4
        Font.Height = -13
        Font.Name = 'Consolas'
        Font.Pitch = fpFixed
        Font.Quality = fqCleartypeNatural
        ParentColor = False

          end
        end
      end
    end
    object tsSettings: TTabSheet
      Caption = 'groffstudio settings'
      ClientHeight = 631
      ClientWidth = 953
      object chkAutoSaveBuildSettings: TCheckBox
        Left = 0
        Height = 19
        Top = 16
        Width = 309
        Caption = 'save and restore the chosen build settings for next time'
        TabOrder = 0
      end
      object btnSaveSettings: TButton
        Left = 864
        Height = 25
        Top = 600
        Width = 91
        Anchors = [akRight, akBottom]
        Caption = 'save settings'
        OnClick = btnSaveSettingsClick
        TabOrder = 1

        Caption = 'check for updates on startup'
        TabOrder = 2
      end
    end
    object tsGroff: TTabSheet
      Caption = 'groff version'
      ClientHeight = 631
      ClientWidth = 953
      object GroupBox2: TGroupBox
        Left = 20
        Height = 57
        Top = 566
        Width = 913
        Align = alBottom
        BorderSpacing.Left = 20
        BorderSpacing.Right = 20
        BorderSpacing.Bottom = 8
        Caption = 'groff for Windows'
        ClientHeight = 37
        ClientWidth = 909
        TabOrder = 0
        object Label6: TLabel
          Left = 8
          Height = 15
          Top = 8
          Width = 108
          Caption = 'latest version online:'
          ParentColor = False
        end
        object edtOnlineGroffVersionWindows: TEdit
          Left = 136
          Height = 15
          Top = 8
          Width = 676
          Anchors = [akTop, akLeft, akRight]
          BorderStyle = bsNone
          Enabled = False
          TabOrder = 0
          Text = 'fetching ...'
        end
        object btnDownloadGroffWindows: TButton
          Left = 820
          Height = 25
          Top = 5
          Width = 80
          Anchors = [akTop, akRight]
          Caption = 'download it'
          OnClick = btnDownloadGroffWindowsClick
          TabOrder = 1
        end
      end
      object Label7: TLabel
        Left = 8
        Height = 15
        Top = 8
        Width = 941
        Anchors = [akTop, akLeft, akRight]
        Caption = 'as you might guess, groffstudio requires a working installation of groff. this page performs the basic checks for you. note that on windows, everything is harder than it should. :-)'
        Constraints.MaxHeight = 582
        ParentColor = False
        WordWrap = True
      end
      object Label9: TLabel
        Left = 8
        Height = 15
        Top = 56
        Width = 70
        Caption = 'groff version:'
        ParentColor = False
      end
      object edtGroffInstalledVersion: TEdit
        Left = 144
        Height = 15
        Top = 56
        Width = 805
        Anchors = [akTop, akLeft, akRight]
        BorderStyle = bsNone
        Enabled = False
        TabOrder = 1
      end
      object lblTroffCommandNotFound: TLabel
        Left = 8
        Height = 45
        Top = 112
        Width = 940
        Anchors = [akTop, akLeft, akRight]
        Caption = 'groff was not found. in order to use groffstudio, you absolutely need groff in your PATH variable. on unix and unix-like systems, you''ll need to edit the $PATH variable. on windows, i warmly recommend the Rapid Environment Editor for that.'#13#10'please exit groffstudio at your nearest convenience and adjust your PATH variables. then try again.'
        Font.Color = clRed
        ParentColor = False
        ParentFont = False
        Visible = False
        WordWrap = True
      end
      object edtGroffstudioInstalledVersion: TEdit
        Left = 144
        Height = 15
        Top = 77
        Width = 805
        Anchors = [akTop, akLeft, akRight]
        BorderStyle = bsNone
        Enabled = False
        TabOrder = 2
      end
      object Label10: TLabel
        Left = 8
        Height = 15
        Top = 77
        Width = 103
        Caption = 'groffstudio version:'
        ParentColor = False
      end
    end
    object tsAbout: TTabSheet
      Caption = 'about groffstudio'
      ClientHeight = 631
      ClientWidth = 953
      object lblAboutProductName: TLabel
        Left = 0
        Height = 61
        Top = 16
        Width = 315
        Caption = 'groffstudio x.y.z'
        Font.Color = clBlue

        ParentColor = False
        ParentFont = False
      end
      object mLicense: TMemo
        Left = 0
        Height = 418
        Top = 216
        Width = 960
        Anchors = [akTop, akLeft, akRight]
        ScrollBars = ssAutoBoth
        TabOrder = 0
      end
      object lblWebsite: TLabel
        Cursor = crHandPoint
        Left = 120

{$mode objfpc}{$H+}

interface

uses
  Classes, SysUtils, Forms, Controls, Graphics, Dialogs, ComCtrls, StdCtrls,
  ExtCtrls, Buttons, ExtendedNotebook, SynEdit, fphttpclient,
  RegExpr, LCLIntf, LCLType, IniPropStorage, Process, Helpers, fileinfo,
  {$IF DEFINED(WINDOWS)}
  winpeimagereader, opensslsockets,
  {$ELSEIF DEFINED(DARWIN)}
  machoreader, ssockets, sslsockets, sslbase, opensslsockets,
  {$ELSEIF DEFINED(LINUX)}
  elfreader,
  {$ENDIF}
  BuildOutputWindow;

type

  { TMainForm }

  TMainForm = class(TForm)
    btnSaveGroff: TButton;
    btnLoadGroff: TButton;
    btnBuild: TButton;
    btnDownloadGroffWindows: TButton;
    btnSaveSettings: TButton;


    chkUpdateCheckOnStart: TCheckBox;
    chkLogFile: TCheckBox;
    chkAutoSaveBuildSettings: TCheckBox;
    chkPdfMark: TCheckBox;
    chkRefer: TCheckBox;
    chkChem: TCheckBox;
    chkGrn: TCheckBox;
    chkTbl: TCheckBox;
    chkPic: TCheckBox;
    chkEqn: TCheckBox;
    cmbMacro: TComboBox;
    edtGroffInstalledVersion: TEdit;
    edtGroffstudioInstalledVersion: TEdit;
    edtOnlineGroffVersionWindows: TEdit;
    ExtendedNotebook1: TExtendedNotebook;
    GroupBox1: TGroupBox;
    GroupBox2: TGroupBox;

    procedure btnSaveGroffClick(Sender: TObject);
    procedure btnSaveSettingsClick(Sender: TObject);
    procedure FormClose(Sender: TObject; var CloseAction: TCloseAction);
    procedure FormCreate(Sender: TObject);
    procedure lblFossilRepoClick(Sender: TObject);
    procedure lblGithubRepoClick(Sender: TObject);
    procedure lblWebsiteClick(Sender: TObject);
    procedure rdPdfChange(Sender: TObject);
    procedure rdPsChange(Sender: TObject);
    procedure SynEdit1Change(Sender: TObject);
{$IFDEF DARWIN}
    procedure GetSocketHandler(Sender: TObject; const UseSSL: Boolean; out AHandler: TSocketHandler);
{$ENDIF}
  private
    var currentGroffFilePath: String;
    var currentGroffFileName: String;

  chkUpdateCheckOnStart.Checked := updateCheck;
{$ENDIF}

  if storeBuildSettings then
  begin
       chkLogFile.Checked := iniStorage.ReadBoolean('BuildLogFile', False);
       cmbMacro.Text := iniStorage.ReadString('BuildChosenMacro', '[ select ]');
       chkChem.Checked := iniStorage.ReadBoolean('BuildUseChem', False);
       chkEqn.Checked := iniStorage.ReadBoolean('BuildUseEqn', False);
       chkGrn.Checked := iniStorage.ReadBoolean('BuildUseGrn', False);
       chkPic.Checked := iniStorage.ReadBoolean('BuildUsePic', False);
       chkRefer.Checked := iniStorage.ReadBoolean('BuildUseRefer', False);
       chkTbl.Checked := iniStorage.ReadBoolean('BuildUseTbl', False);

       chkPdfMark.Checked := iniStorage.ReadBoolean('BuildUsePdfMark', False);
       rdPs.Checked := iniStorage.ReadBoolean('BuildToPostscript', False);
       rdPdf.Checked := iniStorage.ReadBoolean('BuildToPDF', False);
  end;

  // What's the latest available version?
  FileVerInfo := TFileVersionInfo.Create(nil);

end;

procedure TMainForm.lblWebsiteClick(Sender: TObject);
begin
  OpenURL('https://groff.tuxproject.de');
end;

procedure TMainForm.rdPdfChange(Sender: TObject);
begin
  chkPdfMark.Enabled := True;
end;

procedure TMainForm.rdPsChange(Sender: TObject);
begin
  chkPdfMark.Enabled := False;
end;

procedure TMainForm.SynEdit1Change(Sender: TObject);
begin
  // Set the "Changed" mark:
  MainStatusBar.Panels[0].Text := '* ' + currentGroffFileName;
  unsavedChanges := True;
end;

  // - Macro:
  if cmbMacro.SelText <> '' then buildOpts := buildOpts + ' -' + cmbMacro.SelText;

  // - Enforce UTF-8:
  buildOpts := buildOpts + ' -Kutf8';

  // - Preprocessors:
  if chkChem.Checked then   buildOpts := buildOpts + ' -chem';
  if chkEqn.Checked then    buildOpts := buildOpts + ' -eqn';
  if chkGrn.Checked then    buildOpts := buildOpts + ' -grn';
  if chkPic.Checked then    buildOpts := buildOpts + ' -pic';
  if chkRefer.Checked then  buildOpts := buildOpts + ' -refer';
  if chkTbl.Checked then    buildOpts := buildOpts + ' -tbl';



  // - PDF-specifics:
  if rdPdf.Checked then begin
    buildOpts := buildOpts + ' -Tpdf';
    if chkPdfMark.Checked then buildOpts := buildOpts + ' -mpdfmark';
    outputFileName := currentGroffFilePath + '.pdf';
  end
  else outputFileName := currentGroffFilePath + '.ps';

  // - Input file:
  buildOpts := buildOpts + ' ' + currentGroffFilePath;
  buildOpts := buildOpts + ' > ' + outputFileName;

end;

procedure TMainForm.btnSaveSettingsClick(Sender: TObject);
begin
  // Store the build settings:
  iniStorage.WriteString('BuildChosenMacro', cmbMacro.Text);
  iniStorage.WriteBoolean('BuildLogFile', chkLogFile.Checked);
  iniStorage.WriteBoolean('BuildUseChem', chkChem.Checked);
  iniStorage.WriteBoolean('BuildUseEqn', chkEqn.Checked);
  iniStorage.WriteBoolean('BuildUseGrn', chkGrn.Checked);
  iniStorage.WriteBoolean('BuildUsePic', chkPic.Checked);
  iniStorage.WriteBoolean('BuildUseRefer', chkRefer.Checked);
  iniStorage.WriteBoolean('BuildUseTbl', chkTbl.Checked);

  iniStorage.WriteBoolean('BuildUsePdfMark', chkPdfMark.Checked);
  iniStorage.WriteBoolean('BuildToPostscript', rdPs.Checked);
  iniStorage.WriteBoolean('BuildToPDF', rdPDF.Checked);

  // Store the IDE settings:
  iniStorage.WriteBoolean('AutoSaveBuildSettings', chkAutoSaveBuildSettings.Checked);
  iniStorage.WriteBoolean('AutoUpdateCheck', chkUpdateCheckOnStart.Checked);