BeatLyrics/BeatLyrics/RubyTextMeshProUGUI.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
using TMPro;
using UnityEngine;

namespace BeatLyrics
{
    //SOURCE: https://github.com/jp-netsis/RubyTextMeshPro/blob/5dbc919f2842ec1fe8e07b792afb01da853c5ea2/Assets/RubyTextMeshPro/Source/RubyTextMeshProUGUI.cs
    public class RubyTextMeshProUGUI : TextMeshProUGUI
    {
        protected enum RubyShowType
        {
            RUBY_ALIGNMENT,
            BASE_ALIGNMENT
        }

        // ruby tag <亜=あ>
        private static readonly Regex RubyRegex = new Regex(@"<(?<val>[\s\S]+?)=(?<ruby>[\s\S]+?)>");

        [Tooltip("v offset ruby. (em, px, %).")]
        [SerializeField] private string rubyVerticalOffset = "1em";

        [Tooltip("ruby scale. (1=100%)")]
        [SerializeField] private float rubyScale = 0.7f;

        [Tooltip("ruby show type.")]
        [SerializeField] private RubyShowType rubyShowType = RubyShowType.RUBY_ALIGNMENT;

        [Tooltip("all v compensation ruby.")]
        [SerializeField] private bool allVCompensationRuby = false;
        [Tooltip("all ruby v compensation. (em, px, %).")]
        [SerializeField] private string allVCompensationRubyLineHeight = "1.945em";

        [SerializeField]
        [TextArea(5, 10)]
        private string m_uneditedText;

        public string UnditedText
        {
            set { m_uneditedText = value; SetTextCustom(m_uneditedText); }
        }

        private void SetTextCustom(string value)
        {
            text = ReplaceRubyTags(value);

            // SetLayoutDirty called
            if (m_layoutAlreadyDirty)
            {
                // changes to the text object properties need to be applied immediately.
                ForceMeshUpdate();
            }
        }

        /// <summary>
        /// replace ruby tags.
        /// </summary>
        /// <param name="str"></param>
        /// <returns>relpaced str</returns>
        private string ReplaceRubyTags(string str)
        {
            if (string.IsNullOrEmpty(str)) return str;
            var hiddenSpaceW = GetPreferredValues("\u00A0").x * (m_isOrthographic ? 1 : 10f);
            // Replace <ruby> tags text layout.
            var matches = RubyRegex.Matches(str);
            foreach (Match match in matches)
            {
                if (match.Groups.Count != 3) continue;
                var fullMatch = match.Groups[0].ToString();
                var rubyText = match.Groups["ruby"].ToString();
                var baseText = match.Groups["val"].ToString();

                var rubyTextW = GetPreferredValues(rubyText).x * (m_isOrthographic ? 1 : 10f) * rubyScale;
                var baseTextW = GetPreferredValues(baseText).x * (m_isOrthographic ? 1 : 10f);
                var dir = isRightToLeftText ? 1 : -1;
                var rubyTextOffset = dir * (baseTextW / 2f + rubyTextW / 2f);
                var compensationOffset = -dir * ((baseTextW - rubyTextW) / 2f);
                var replace = CreateReplaceValue(baseText, rubyText, rubyTextOffset, compensationOffset, hiddenSpaceW);
                str = str.Replace(fullMatch, replace);
            }
            if (allVCompensationRuby)
            {
                // warning! bad Know-how
                // line-height tag is down the next line start.
                // now line can't change, corresponding by putting a hidden ruby
                var dir = isRightToLeftText ? 1 : -1;
                // Get hidden ruby width
                var spaceTextWidth = hiddenSpaceW * rubyScale;
                var compensationOffset = dir * spaceTextWidth;
                str = $"<line-height={allVCompensationRubyLineHeight}><voffset={rubyVerticalOffset}><size={rubyScale * 100f}%>\u00A0</size></voffset><space={compensationOffset}>" + str;
            }

            return str;
        }

        private string CreateReplaceValue(string baseText, string rubyText, float rubyTextOffset, float compensationOffset, float hiddenSpaceW)
        {
            var replace = string.Empty;
            switch (rubyShowType)
            {
                case RubyShowType.RUBY_ALIGNMENT:
                    if (compensationOffset < 0)
                    {
                        replace = $"<nobr><space={-compensationOffset}>{baseText}<space={rubyTextOffset}><voffset={rubyVerticalOffset}><size={rubyScale * 100f}%>{rubyText}</size></voffset></nobr>";
                    }
                    else
                    {
                        var n = Mathf.CeilToInt(compensationOffset / hiddenSpaceW);
                        var hiddenSpaceSize = compensationOffset / hiddenSpaceW / n;
                        string hiddenSpaces = new string(' ', n);
                        replace = $"<nobr>{baseText}<space={rubyTextOffset}><voffset={rubyVerticalOffset}><size={rubyScale * 100f}%>{rubyText}</size></voffset><size={hiddenSpaceSize * 100f}%>{hiddenSpaces}</size></nobr>";
                    }
                    break;

                case RubyShowType.BASE_ALIGNMENT:
                    replace = $"<nobr>{baseText}<space={rubyTextOffset}><voffset={rubyVerticalOffset}><size={rubyScale * 100f}%>{rubyText}</size></voffset><space={compensationOffset}></nobr>";
                    break;
            }

            return replace;
        }

#if UNITY_EDITOR

        protected override void OnValidate()
        {
            base.OnValidate();

            SetTextCustom(m_uneditedText);
        }

#endif
    }
}