Keep configuration files in a subdirectory

Entity mappings are now under the 'HTML 5' section; older configs
have them under 'HTML 4', so no entities will be recognized in
current and later plugin versions

Since b7ea8a5, the user's entity file is preferred over the
installed one. Changing the file path ensures the new file gets
copied to the config directory and loaded after a plugin upgrade

Old configs will be ignored, but that's a gentler breaking change
than losing all entity decoding functionality

Author: rdipardo

src/Forms/AboutForm.pas

@@ -150,7 +150,7 @@ constructor TFrmAbout.Create(AOwner: TComponent);
     WrapFilePath(txtHomeDir);
 
     lblConfigDir := MakeText('Config location');
-    txtConfigDir := MakeText(UTF8ToAnsi(UTF8Encode(Npp.ConfigDir)), 24);
+    txtConfigDir := MakeText(UTF8ToAnsi(UTF8Encode(Npp.PluginConfigDir)), 24);
     WrapFilePath(txtConfigDir);
 
     lblEntities := MakeText('HTML entities file');
@@ -306,7 +306,7 @@ procedure TFrmAbout.FindEntities;
   FEntities := Npp.Entities;
 
   if not FileExists(FEntities) then
-    FEntities := ChangeFilePath(Npp.Entities, TSpecialFolders.DLL);
+    FEntities := Npp.DefaultEntitiesPath;
 
   txtEntities.Text := UTF8Encode(FEntities);
 

src/U_Entities.pas

@@ -56,10 +56,10 @@ function LoadEntities(ANpp: TNppPluginHTMLTag; ASet: string = 'HTML 5'): TString
     Result := TStringList(EntityLists.Objects[i]);
   end else begin
     IniFile := ANpp.Entities;
-    ErrMsg := WideFormat('%s must be saved to'#13#10'%s', [EntitiesConf, ExtractFileDir(IniFile)]);
+    ErrMsg := WideFormat('%s must be saved in'#13#10'%s', [ExtractFileName(IniFile), ExtractFileDir(IniFile)]);
     if not FileExists(IniFile) then
-      IniFile := ChangeFilePath(IniFile, TSpecialFolders.DLL);
-      ErrMsg := Concat(ErrMsg, WideFormat(#13#10'or to'#13#10'%s', [ExtractFileDir(IniFile)]));
+      IniFile := Npp.DefaultEntitiesPath;
+      ErrMsg := Concat(ErrMsg, WideFormat(#13#10'or %s in'#13#10'%s', [ExtractFileName(IniFile), TSpecialFolders.DLL]));
     if not FileExists(IniFile) then begin
       MessageBoxW(ANpp.App.WindowHandle, PWideChar(ErrMsg), PWideChar('Missing Entities File'), MB_ICONERROR);
       FreeAndNil(EntityLists);

src/U_Npp_HTMLTag.pas

@@ -17,9 +17,6 @@ interface
   AboutForm,
   NppSimpleObjects, L_VersionInfoW;
 
-const
-  EntitiesConf: nppString = 'HTMLTag-entities.ini';
-
 type
   TDecodeCmd = (dcAuto = -1, dcEntity, dcUnicode);
   TCmdMenuPosition = (cmpUnicode = 3, cmpEntities);
@@ -37,6 +34,9 @@   TNppPluginHTMLTag = class(TNppPlugin)
     FOptions: TPluginOptions;
     function GetOptionsFilePath: nppString;
     function GetEntitiesFilePath: nppString;
+    function GetDefaultEntitiesPath: nppString;
+    function PluginNameFromModule: nppString;
+    function GetConfigDir: nppString;
     procedure LoadOptions;
     procedure SaveOptions;
     procedure FindAndDecode(const KeyCode: Integer; Cmd: TDecodeCmd = dcAuto);
@@ -63,6 +63,8 @@   TNppPluginHTMLTag = class(TNppPlugin)
     property Version: nppString  read FVersionStr;
     property OptionsConfig: nppString  read GetOptionsFilePath;
     property Entities: nppString  read GetEntitiesFilePath;
+    property DefaultEntitiesPath: nppString  read GetDefaultEntitiesPath;
+    property PluginConfigDir: nppString read GetConfigDir;
   end;
 
 procedure _commandFindMatchingTag(); cdecl;
@@ -85,7 +87,6 @@ procedure _commandAbout(); cdecl;
 implementation
 
 uses
-  Strutils,
   ShellAPI,
   L_SpecialFolders,
   Utf8IniFiles,
@@ -207,11 +208,7 @@ constructor TNppPluginHTMLTag.Create;
 
   try
      FVersionInfo := TFileVersionInfo.Create(TSpecialFolders.DLLFullName);
-{$IFDEF FPC}
-     FVersionStr := UTF8ToString(ChangeFileExt(ExtractFileName(UTF8Encode(TSpecialFolders.DLLFullName)), ''));
-{$ELSE}
-     FVersionStr := ChangeFileExt(ExtractFileName(TSpecialFolders.DLLFullName), '');
-{$ENDIF}
+     FVersionStr := PluginNameFromModule();
      FVersionStr :=
       Concat(FVersionStr,
         WideFormat(' %d.%d.%d (%s bit)',
@@ -220,10 +217,6 @@ constructor TNppPluginHTMLTag.Create;
   except
     FreeAndNil(FVersionInfo);
   end;
-
-{$IFNDEF CPUX64}
-  FVersionStr := UTF8ToString(ReplaceStr(UTF8Encode(FVersionStr), '_unicode', ''));
-{$ENDIF}
 end;
 
 { ------------------------------------------------------------------------------------------------ }
@@ -242,7 +235,7 @@ procedure TNppPluginHTMLTag.SetInfo(NppData: TNppData);
 begin
   inherited SetInfo(NppData);
   if not FileExists(Entities) then
-    CopyFileW(PWChar(ChangeFilePath(Entities, TSpecialFolders.DLL)), PWChar(Entities), True);
+    CopyFileW(PWChar(DefaultEntitiesPath), PWChar(Entities), True);
 
   LoadOptions;
 end;
@@ -433,17 +426,35 @@ procedure TNppPluginHTMLTag.commandAbout;
 { ------------------------------------------------------------------------------------------------ }
 function TNppPluginHTMLTag.GetEntitiesFilePath: nppString;
 begin
-  Result := IncludeTrailingPathDelimiter(Self.ConfigDir) + EntitiesConf;
+  Result := IncludeTrailingPathDelimiter(Self.PluginConfigDir) + 'entities.ini';
 end {TNppPluginHTMLTag.GetEntitiesFilePath};
 
 { ------------------------------------------------------------------------------------------------ }
 function TNppPluginHTMLTag.GetOptionsFilePath: nppString;
+begin
+  Result := IncludeTrailingPathDelimiter(Self.PluginConfigDir) + 'options.ini';
+end;
+
+{ ------------------------------------------------------------------------------------------------ }
+function TNppPluginHTMLTag.GetDefaultEntitiesPath: nppString;
+begin
+  Result := IncludeTrailingPathDelimiter(TSpecialFolders.DLL) + PluginNameFromModule() + '-entities.ini';
+end;
+
+{ ------------------------------------------------------------------------------------------------ }
+function TNppPluginHTMLTag.PluginNameFromModule: nppString;
 var
   PluginName: WideString;
 begin
   PluginName := ChangeFileExt(ExtractFileName(TSpecialFolders.DLLFullName), EmptyWideStr);
-  PluginName := WideStringReplace(PluginName, '_unicode', EmptyWideStr, []);
-  Result := IncludeTrailingPathDelimiter(Self.ConfigDir) + PluginName + '.ini';
+  Result := WideStringReplace(PluginName, '_unicode', EmptyWideStr, []);
+end;
+
+{ ------------------------------------------------------------------------------------------------ }
+function TNppPluginHTMLTag.GetConfigDir: nppString;
+begin
+  Result := IncludeTrailingPathDelimiter(Self.ConfigDir) + PluginNameFromModule();
+  if (not DirectoryExists(Result)) then CreateDir(Result);
 end;
 
 { ------------------------------------------------------------------------------------------------ }