SciTE - Neue AU3-Datei immer mit Kodierung "UTF-8 mit BOM" erstellen

-- TIME_STAMP   2021-04-15 14:02:19


--[[
After a file was saved, the event OnSave will fired.
Now will checked:
- needs this file typ the BOM?
- If Yes: Has this file already the BOM?
-          If No: Write the BOM sequence at the beginning of the file


If you want register other types as "au3" for set BOM use this property in SciTEUser.properties:

#~ File types, that needs byte order mark
#~ "au3" is predefined and does not need to be set here
BOM.File.Types=extension_1 extension_2
]]


CheckBOM = EventClass:new(Common)

CheckBOM.OnSave = function(self, _file)
    if not self:NeedsBOM(props['FileExt']) then return nil end
    if not self:StartsWithBOM(_file) then scite.MenuCommand(153) end
    return nil
end

CheckBOM.StartsWithBOM = function(self, _file)
    local ToHex = function(_s)
        if _s == nil then return "DEAD" end
        return (_s:gsub('.', function(_c) return ('%02X'):format(_c:byte()) end))
    end
    local fh = io.open(_file, "rb")
    local read = fh:read(3)
    fh:close()
    return (ToHex(read) == "EFBBBF")
end

CheckBOM.NeedsBOM = function(self, _ext)
    local extensions = props['BOM.File.Types']:lower()..' au3'
    if extensions:find(_ext:lower()) then return true else return false end
end

-- TIME_STAMP   2017-05-26 11:19:55


NewFile = EventClass:new(Common)


function NewFile:OnUpdateUI(filename)
    if props["FileName"] == "" then
        -- set to UTF-8 with BOM
        scite.MenuCommand(153) -- 153 = IDM_ENCODING_UTF8
    end
    return nil  -- default processing
end

;-- TIME_STAMP   2017-05-27 13:57:52   v 0.1


#RequireAdmin


_FileCreateTemplate()




Func _FileCreateTemplate()
    Local $sCreator = _GetAU3Property('UDFCreator', @UserName)
    Local $sWrite = _
    "#cs ----------------------------------------------------------------------------" & @CRLF & @CRLF & _
    " AutoIt Version:  " & @AutoItVersion & @CRLF & _
    " Author:          " & ($sCreator = "Your Name" ? @UserName : $sCreator) & @CRLF & @CRLF & _
    " Script Function: AutoIt script." & @CRLF & @CRLF & _
    "#ce ----------------------------------------------------------------------------" & @CRLF & @CRLF & _
    "; Script Start - Add your code below here" & @CRLF
    Local $sFileName = @WindowsDir & "\ShellNew\Template.au3"
    If Not FileExists($sFileName) Then Exit MsgBox(262192, 'Fehler', 'Es ist keine Datei "Template.au3" installiert!')
    Local $fH = FileOpen($sFileName, 2+128)
    Local $iSucc = FileWrite($fH, $sWrite)
    FileClose($fH)
    Exit MsgBox(($iSucc = 1 ? 262208 : 262192), ($iSucc = 1 ? 'Fertig!' : 'Fehler!'), ($iSucc = 1 ? _
        'Das personalisierte Template wurde erfolgreich geschrieben.' : 'Das Template konnte nicht geschrieben werden.'))
EndFunc




; #FUNCTION# ====================================================================================================================
; Name ..........: _GetAU3Property
; Description ...: Gets a property value (one-line entry only!). Ask order: 1. SciTEUser.properties 2. au3.properties
; Syntax ........: _GetAU3Property($sProperty[, $sDefault = ''])
; Parameters ....: $sProperty           - The property name
;                  $sDefault            - [optional] A value to use, if none property set. Default is ''.
; Return values .: The value of the property (or the default value)
; Author ........: BugFix
; ===============================================================================================================================
Func _GetAU3Property($sProperty, $sDefault='')
    Local $sPathUserProp = @LocalAppDataDir & "\AutoIt v3\SciTE\SciTEUser.properties"         ; C:\Users\[USER]\AppData\Local\AutoIt v3\SciTE\SciTEUser.properties
    Local $sPathAU3Prop = StringTrimRight(@AutoItExe, 11) & "SciTE\properties\au3.properties" ; C:\Program Files (x86)\AutoIt3\SciTE\properties\au3.properties
    Local $sRead = '', $sValueReturn = $sDefault, $aMatch
    Local $sPattern = $sProperty & "=([^\r\n]+)"
    If FileExists($sPathUserProp) Then $sRead = FileRead($sPathUserProp)
    $aMatch = StringRegExp($sRead, $sPattern, 1)
    If @error Then
        If FileExists($sPathAU3Prop) Then $sRead = FileRead($sPathAU3Prop)
        $aMatch = StringRegExp($sRead, $sPattern, 1)
        If Not @error Then $sValueReturn = $aMatch[0]
    Else
        $sValueReturn = $aMatch[0]
    EndIf
    Return $sValueReturn
EndFunc

-- TIME_STAMP   2021-04-20 11:19:47
-- coding:utf-8


--[[
PROPERTIES:
# The only way to detect the UTF8 encoding is using a coding cookie in one of the 1st two lines.
# line to insert the utf8-cookie (1 or 2), default: 1
UTF8.Cookie.Line=

# file types, that needs this codings
# 'utf8' - as default declared: 'lua'
# 'utf8bom' - as default declared: 'au3'
UTF8.File.Types=ext_1 ext_2
UTF8BOM.File.Types=ext_1 ext_2
UTF16LE.File.Types=ext_1 ext_2
UTF16BE.File.Types=ext_1 ext_2

]]

ForceEncoding = EventClass:new(Common)

ForceEncoding.OnSave = function(self, _file)
    local enc = self:NeedsEncoding(props['FileExt'])
    if enc == 'NONE' then return nil end
    if not (self:Get(_file) == enc) then  -- file has not the required encoding
        if enc == 'UTF8' then      -- IDM_ENCODING_UCOOKIE    154    UTF8  (not save without real text cookie!)
            self:InsertUTF8Cookie()
            scite.MenuCommand(IDM_ENCODING_UCOOKIE)
        else
            local tCmd = {['UTF8BOM']=IDM_ENCODING_UTF8,['UTF16LE']=IDM_ENCODING_UCS2LE,['UTF16BE']=IDM_ENCODING_UCS2BE}
            scite.MenuCommand(tCmd.enc)
        end
    end
    return nil
end

-- inserts the coding cookie in line 1 or 2
ForceEncoding.InsertUTF8Cookie = function()
    local l = tonumber(props['UTF8.Cookie.Line']) or 1    -- if prop not set use 1st line
    if l > 2 then l = 2 end                               -- last possible line for this cookie
    local countLines = editor.LineCount
    if countLines < l then l = 1 end                      -- file is empty or has only one line and cookie prop is set to 2
    local lineComment = props['comment.block.'..props['FileExt']]
    l = l -1                                              -- 0-based line index
    local caret = editor.CurrentPos
    local firstVisibleLine = editor.FirstVisibleLine
    local pos = editor:PositionFromLine(l)                -- start position from line
    editor:InsertText(pos, lineComment..' coding:utf-8\n')
    editor:SetSel(caret, caret)
    editor.FirstVisibleLine = firstVisibleLine
end

-- returns the encoding, that the file type needs
ForceEncoding.NeedsEncoding = function(self, _ext)
    local tExt = {}
    tExt["UTF8"]    = props['UTF8.File.Types']:lower()..' lua'
    tExt["UTF8BOM"] = props['UTF8BOM.File.Types']:lower()..' au3'
    tExt["UTF16LE"] = props['UTF16LE.File.Types']:lower()
    tExt["UTF16BE"] = props['UTF16BE.File.Types']:lower()
    for enc in pairs(tExt) do
        if tExt[enc]:find(_ext:lower()) then return enc end
    end
    return 'NONE'
end

-- detects: 'UTF8BOM', 'UTF16LE', 'UTF16BE' by it's byte marker (from file)
-- and 'UTF8' if coding cookie is set on one of the first two lines: (from editor pane)
-- A coding cookie looks similar to "coding: utf-8" ("coding" followed by ':' or '=', optional whitespace, optional quote, "utf-8").
ForceEncoding.Get = function(self, _file)
    local tEnc = {}
    tEnc['UTF8BOM'] = {['len']=3,['hex']="EFBBBF"}
    tEnc['UTF16LE'] = {['len']=2,['hex']="FFFE"}
    tEnc['UTF16BE'] = {['len']=2,['hex']="FEFF"}
    local n, line, fh, content, read = 0
    -- 1st. check for coding cookie (UTF8)
    for i=0, 1 do
        line = editor:GetLine(i)
        if line == nil then break
        else if line:find("coding[:=]%s-['\"]-utf%-8") then return "UTF8" end end
    end
    -- now check for byte marker
    for enc in pairs(tEnc) do
        if self:ToHex(self:ReadLen(_file, tEnc[enc].len)) == tEnc[enc].hex then return enc end
    end
    return 'UNKNOWN'
end

-- reads a count of bytes from a file
ForceEncoding.ReadLen = function(self, _file, _n)
    local fh = io.open(_file, "rb")
    local read = fh:read(_n)
    fh:close()
    return read
end

-- converts a passed string to hex value of its characters
ForceEncoding.ToHex = function(self, _s)
    if _s == nil then return 'DEAD' end
    return (_s:gsub('.', function(_c) return ('%02X'):format(_c:byte()) end))
end