com.hcl.domino.jna.misc.LMBCSCharsetProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-jna-r14 Show documentation
The newest version!
/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * Licensed under the  Apache License, Version 2.0  (the "License").  You may
 * not use this file except in compliance with the License.  You may obtain a
 * copy of the License at .
 *
 * Unless  required  by applicable  law or  agreed  to  in writing,  software
 * distributed under the License is distributed on an  "AS IS" BASIS, WITHOUT
 * WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the  specific language  governing permissions  and limitations
 * under the License.
 * ==========================================================================
 */
package com.hcl.domino.jna.misc;

import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import java.nio.charset.Charset;
import java.nio.charset.CharsetDecoder;
import java.nio.charset.CharsetEncoder;
import java.nio.charset.CoderResult;
import java.nio.charset.spi.CharsetProvider;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;

import com.hcl.domino.jna.internal.NotesStringUtils;
import com.hcl.domino.jna.internal.NotesStringUtils.LineBreakConversion;
import com.sun.jna.Memory;

public class LMBCSCharsetProvider extends CharsetProvider {
  public static final String NAME = "LMBCS"; //$NON-NLS-1$
  public static final List ALIASES = Arrays.asList("LMBCS-native"); //$NON-NLS-1$
  public static final String NAME_NULLTERM = "LMBCS-nullterm"; //$NON-NLS-1$
  public static final String NAME_KEEPNEWLINES = "LMBCS-keepnewlines"; //$NON-NLS-1$
  public static final String NAME_NULLTERM_KEEPNEWLINES = "LMBCS-nullterm-keepnewlines"; //$NON-NLS-1$

  public static class LMBCSCharset extends Charset {
    /** LMBCS charset that does not add a null terminator and replaces newlines with \0 during encoding */
    public static final LMBCSCharset INSTANCE = new LMBCSCharset(NAME, ALIASES.toArray(new String[ALIASES.size()]), false, true);
    /** LMBCS charset that adds a null terminator and replaces newlines with \0 during encoding */
    public static final LMBCSCharset INSTANCE_NULLTERM = new LMBCSCharset(NAME, ALIASES.toArray(new String[ALIASES.size()]), true, true);
    /** LMBCS charset that does not add a null terminator and does not replace newlines with \0 during encoding */
    public static final LMBCSCharset INSTANCE_KEEPNEWLINES = new LMBCSCharset(NAME, ALIASES.toArray(new String[ALIASES.size()]), false, false);
    /** LMBCS charset that adds a null terminator and does not replace newlines with \0 during encoding */
    public static final LMBCSCharset INSTANCE_NULLTERM_KEEPNEWLINES = new LMBCSCharset(NAME, ALIASES.toArray(new String[ALIASES.size()]), true, false);

    private boolean addNull;
    private LineBreakConversion lineBreakConv;
    
		protected LMBCSCharset(String canonicalName, String[] aliases, boolean addNull, boolean replaceLineBreaks) {
			super(canonicalName, aliases);
			this.addNull = addNull;
			if (replaceLineBreaks) {
			  lineBreakConv = LineBreakConversion.NULL;
			}
			else {
			  lineBreakConv = LineBreakConversion.ORIGINAL;
			}
		}

		@Override
		public boolean contains(Charset cs) {
			return this.equals(cs);
		}

		@Override
		public CharsetDecoder newDecoder() {
			return new CharsetDecoder(this, 1, 2) {
				@Override
				protected CoderResult decodeLoop(ByteBuffer in, CharBuffer out) {
					if(!in.hasRemaining()) {
						return CoderResult.UNDERFLOW;
					}
					byte[] bytes = new byte[in.remaining()];
					in.get(bytes, 0, in.remaining());
					String decoded = NotesStringUtils.fromLMBCS(bytes);
					out.put(decoded);
					return CoderResult.UNDERFLOW;
				}
			};
		}

		@Override
		public CharsetEncoder newEncoder() {
			return new CharsetEncoder(this, 1, 3) {
				@Override
				protected CoderResult encodeLoop(CharBuffer in, ByteBuffer out) {
					if(!in.hasRemaining()) {
						return CoderResult.UNDERFLOW;
					}
					char[] chars = new char[in.remaining()];
					in.get(chars);
					
					Memory encoded = NotesStringUtils.toLMBCS(new String(chars), addNull, lineBreakConv, false);
					if(out.remaining() < encoded.size()) {
						return CoderResult.OVERFLOW;
					}
					out.put(encoded.getByteBuffer(0, encoded.size()));
					return CoderResult.UNDERFLOW;
				}
				
				@Override
				public boolean isLegalReplacement(byte[] repl) {
					// TODO check if we should properly implement this
					return true;
				}
			};
		}
		
	}

	@Override
	public Iterator charsets() {
	  return Arrays.asList(
	      (Charset)LMBCSCharset.INSTANCE,
	      (Charset)LMBCSCharset.INSTANCE_NULLTERM,
	      (Charset)LMBCSCharset.INSTANCE_KEEPNEWLINES,
	      (Charset)LMBCSCharset.INSTANCE_NULLTERM_KEEPNEWLINES
	      ).iterator();
	}

	@Override
	public Charset charsetForName(String charsetName) {
	  if(NAME.equals(charsetName) || ALIASES.contains(charsetName)) {
	    return LMBCSCharset.INSTANCE;
	  } else if (NAME_NULLTERM.equals(charsetName)) {
	    return LMBCSCharset.INSTANCE_NULLTERM;
	  } else if (NAME_NULLTERM_KEEPNEWLINES.equals(charsetName)) {
	    return LMBCSCharset.INSTANCE_NULLTERM_KEEPNEWLINES;
	  } else if (NAME_KEEPNEWLINES.equals(charsetName)) {
	    return LMBCSCharset.INSTANCE_KEEPNEWLINES;
	  } else {
	    return null;
	  }
	}

}